OntapClusterAPI - Contains the definitions and description of API Bindings for clustered Data ONTAP
my $s = NaServer->new($server, 1, 0); # create NaServer (server context)
$s->set_admin_user('admin', 'password'); # provide username and password
eval{
my $output = $s->system_get_version(); # use binding for system-get-version API
print "Data ONTAP version: $output->{version}\n"; # extract the required parameter from output
print "Clustered: $output->{is-clustered}\n";
my $tuple = $output->{'version-tuple'}->{'system-version-tuple'};
print "Generation: $tuple->{generation} Major: $tuple->{major} Minor: $tuple->{minor} \n";
$output = $s->quota_status_iter('query' => { 'quota-status-attributes' => {'volume' => 'vol0'}} ); # nested parameters as hashes of hashes
print "Quota Status: $output->{'attributes-list'}->{'quota-status-attributes'}->{'status'} \n";
};
if($@) { # check for any exception
my ($error_reason, $error_code) = $@ =~ /(.+)\s\((\d+)\)/; # parse out error reason and error code
print "Error Reason: $error_reason Code: $error_code\n"
}
NetApp Manageability SDK 9.6 provides support for Perl API bindings for both Data ONTAP APIs and Active IQ Unified Manager (formerly OnCommand Unified Manager) APIs. The Perl API bindings libraries contain interfaces to establish a connection with either the Data ONTAP server or the Active IQ Unified Manager (formerly OnCommand Unified Manager) server. By using these libraries, you can create Perl applications to access and manage the Data ONTAP server or Active IQ Unified Manager (formerly OnCommand Unified Manager) server.
NetApp Manageability SDK 9.6 Perl API bindings provide a runtime library NaServer.pm, which is available at <installation_folder>/lib/perl/NetApp. This library file enables you to establish a server connection, send requests and receive responses, and interpret error messages. Each binding can be called as a subroutine of NaServer module which in turn invokes the corresponding Data ONTAP or Active IQ Unified Manager (formerly OnCommand Unified Manager) API.
[Family: vserver]
Create an Active Directory account for the given Vserver. If a CIFS server already exists for the requested Vserver, then this command will fail. The existing CIFS server should be deleted before retrying again. If joining a domain, this command may take several minutes to complete.Inputs
Outputs
[Family: vserver]
Delete the Active Directory account. If a CIFS server already exists for the requested Vserver, cifs-server-delete API should be used to delete the machine account.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of active directory accountsInputs
Outputs
[Family: vserver]
Modify the Windows Active Directory domain. If a CIFS server already exists for the requested Vserver, cifs-server-modify API should be used to modify the Windows Active Directory domain. If re-joining the current domain or joining a new one, this command may take several minutes to complete.Inputs
Outputs
[Family: vserver]
Generate a new password for the machine account and change it in the Windows Active Directory domain.Inputs
Outputs
[Family: vserver]
Reset the machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.Inputs
Outputs
[Family: cluster]
Add disks to the specified aggregate. The disks to add are specified in the same way as for "aggr-create". Disks cannot be added to a mirrored aggregate if one or more of the plexes is offline. By the time the API returns, the disk(s) may not yet be completely added. Use 'aggr-list-info' to query the aggregate status to determine when it has finished growing due to the added disk(s). Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. When the upgrade-64bit-mode input is provided to this API, the API produces a set of results in the background. These results are not available as output from aggr-add. Use the 'aggr-list-info' and 'volume-list-info' APIs to query the results of the 64-bit upgrade process on the aggregate and flexible volumes, respectively.Inputs
Outputs
[Family: cluster]
Iterate over a list of aggr-autobalance objects.Inputs
Outputs
[Family: cluster]
Displays the configuration for Auto Balance Aggregate.Inputs
Outputs
[Family: cluster]
Modifies Auto Balance Aggregate configuration.Inputs
Outputs
[Family: cluster]
Displays the nodes that notify Auto Balance Aggregate about aggregates that need to be balancedInputs
Outputs
[Family: cluster]
Iterate over a list of aggr-autobalance objects.Inputs
Outputs
[Family: cluster]
Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.Inputs
Outputs
[Family: cluster]
Create a new aggregate with the given name. The maximum number of aggregates that can be created on a filer varies by the type of configuration. In a standalone configuration, up to 200 aggregates can be created on a filer. In an HA configuration, this number drops to 100 and to 50 in a C-mode MetroCluster configuration. The aggregate may not yet be operational immediately after the API returns. Use 'aggr-list-info' to query the status of the newly-created aggregate to determine when it is fully operational. Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. NOTE: If ECANT_USE_ALL_DISKS is returned, then the requested aggregate was indeed created, just not with all the disks that were specified.Inputs
Outputs
[Family: cluster]
Destroys the specified aggregate or plex. If an aggregate is specified, all plexes in the aggregate are destroyed. If a plex is specified, only that plex is destroyed, leaving an unmirrored aggregate containing the remaining plex. The disks in the destroyed object become spare disks. Only offline aggregates and plexes can be destroyed. Note: Offline aggregates will be destroyed even if they contain one or more flexible volumes, which should not typically be the case. From cluster interface only aggregates are supported and plexes are not supported.Inputs
Outputs
[Family: cluster]
Display the cumulated efficiency ratio for the specified aggregatesInputs
Outputs
[Family: cluster]
Display the all Flash optimized aggregates and their storage efficiency.Inputs
Outputs
[Family: cluster]
Get information on what possibilities and parameters exist for aggregates on a given filer.Inputs
Outputs
[Family: cluster]
Iterate over a list of aggregate objects.Inputs
Outputs
[Family: cluster]
Turns an unmirrored aggregate into a mirrored aggregate by adding a plex to it. The plex is either newly formed from disks chosen from a spare pool or, if the "victim-aggregate" option is specified, taken from another existing unmirrored aggregate. The named aggregate must currently be unmirrored. Disks may be specified explicitly using the "mirror-disks" list option in the same way as with the "aggr-create" and "aggr-add" commands. The number of disks indicated must match the number present in the existing aggregate. If disks are not specified explicitly, then disks are automatically selected to match those in the aggregate's existing plex.Inputs
Outputs
[Family: cluster]
Modify the RAID type for the given aggregate to the specified "raid-type". This API can also selectively change the RAID type of specific raid groups in the aggregate based on the specified "disk-type". The change remains effective even if the filer is rebooted. This API does not support modifying options of a striped aggregate.Inputs
Outputs
[Family: cluster]
Attach an object store to an aggregateInputs
Outputs
[Family: cluster]
Create an object store configuration.Inputs
Outputs
[Family: cluster]
Delete an object store configurationInputs
Outputs
[Family: cluster]
Get the attributes of an object store configuration.Inputs
Outputs
[Family: cluster]
Iterate over a list of object store configurations.Inputs
Outputs
[Family: cluster]
Modify an existing object store configuration.Inputs
Outputs
[Family: cluster]
Returns a list of supported object store providers.Inputs
Outputs
[Family: cluster]
Display a list of aggregates which object stores are attached to.Inputs
Outputs
[Family: cluster]
Display a list of volume buftree UUIDs in a FabricPool aggregate.Inputs
Outputs
[Family: cluster]
Take the specified aggregate or plex offline. The operation takes effect before the API returns. Except in maintenance mode, the current root aggregate may not be taken offline. An aggregate marked to become the root aggregate cannot be taken offline. An aggregate containing one or more flexible volumes cannot be taken offline; its contained volumes must first be destroyed. A number of operations being performed on the given aggregate can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files in the aggregate opened by internal Data ONTAP processes. The command is aborted if any are found.Inputs
Outputs
[Family: cluster]
Bring the specified aggregate or plex online. This command takes effect immediately. All volumes on the aggregate are brought to whatever state they were in before the aggregate was restricted or taken offline. If there are CIFS shares associated with the any of the aggregate's volumes that were also onlined, they are enabled.Inputs
Outputs
[Family: cluster]
Get the options that have been set for the specified aggregate. This API does not support listing options of striped aggregate.Inputs
Outputs
[Family: cluster]
Aggregate RelocationInputs
Outputs
[Family: cluster]
Iterate over the list of aggregate relocation statusInputs
Outputs
[Family: cluster]
Rename the specified aggregate.Inputs
Outputs
[Family: cluster]
Restrict the specified aggregate. An aggregate with one or more flexible volumes cannot be restricted; all of its contained volumes must first be destroyed.Inputs
Outputs
[Family: cluster]
Get aggregate resynchronization options for a node in the clusterInputs
Outputs
[Family: cluster]
Get aggregate resynchronization options for each node in the clusterInputs
Outputs
[Family: cluster]
Modify aggregate resynchronization options for a node in the clusterInputs
Outputs
[Family: cluster]
Get the status of parity scrubbing on the named aggregate. Status includes percentage complete and the scrub's suspended status (if appropriate). If an aggregate or node is not given, then status is generated for all RAID groups.Inputs
Outputs
[Family: cluster]
Resume parity scrubbing on the named aggregate, plex, or RAID group. If an aggregate or node is not given, then resume parity scrubbing on all RAID groups for which it has been suspended. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Start parity scrubbing on the named aggregate, plex, or RAID group. Parity scrubbing compares the data disks to the parity disk in a RAID group, correcting the parity disk's contents as necessary. If an aggregate or node is not given, then parity scrubbing is started on all online aggregates. If an aggregate name is given, scrubbing is started on all RAID groups in the aggregate. If a plex name is given, scrubbing is started on all RAID groups contained in the plex. If a RAID group name is given, scrubbing is started only on that group. Use "aggr-scrub-list-info" to check scrubbing status. If a node is given, scrubbing is started on all raid groups on that node.Inputs
Outputs
[Family: cluster]
Stop parity scrubbing on the named aggregate, plex, or RAID group. If an aggregate or node is not given, scrubbing will stop on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Suspend parity scrubbing on the named aggregate, plex, RAID group, or node. If an aggregate or node is not given, suspend scrubbing on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Set the specified option for the given aggregate to "option-value". The change remains effective even if the filer is rebooted. Some options have values that are numbers, and some have values that are "on" (also expressible as "yes", "true", or "1" ) or "off" (also expressible as "no", "false", or "0"). A mixture of uppercase and lowercase characters may be used when typing an option's value. Note that the "root" option is special in that it doesn't have a corresponding value. This API does not support modifying options of striped aggregate.Inputs
Outputs
[Family: cluster]
Display a list of aggregates and a breakup of their used space. This information is only available when the aggregate is online. Some fields are expensive to compute, and if the system is under load, the information may not be returned. Best practice would be to only request the fields needed.Inputs
Outputs
[Family: cluster]
Iterate over a list of spare disksInputs
Outputs
[Family: cluster]
Aggregate enumeration ZAPI. Get status and topology information about one or more aggregates from RAID subsystem.Inputs
Outputs
[Family: cluster]
Get the status of RAID mirror verification on the named aggregate. Status includes percentage complete and whether it's currently suspended.Inputs
Outputs
[Family: cluster]
Resume RAID mirror verification on the named aggregate. If no name is given, then resume mirror verification on all aggregates that have been suspended.Inputs
Outputs
[Family: cluster]
Start RAID mirror verification on the named aggregate. Verification compares the data in both plexes of a mirrored aggregate. In the default case, any blocks that differ are logged and no changes are made. The fix-plex option is used to fix any mismatches. It specifies which plex to fix. If no name is given, then mirror verification is started on all online aggregates. Use the "aggr-verify-list-info" API to check mirror verification status. If the fix-plex option is used, then a name must be specified.Inputs
Outputs
[Family: cluster]
Stop RAID mirror verification on the named aggregate. If no name is given, stop mirror verification on all aggregates currently being verified.Inputs
Outputs
[Family: cluster]
Suspend RAID mirror verification on the named aggregate. If no name is given, suspend mirror verification on all aggregates currently being verified.Inputs
Outputs
[Family: cluster]
This gets the attributes of the Anti-Virus engine installed.Inputs
Outputs
[Family: cluster]
Get the attributes of the antivirus.Inputs
Outputs
[Family: cluster]
Get the attributes of the antivirus.Inputs
Outputs
[Family: cluster]
This gets the remedy information of the Anti-Virus engine installed. i.e. what to do when a virus is found.Inputs
Outputs
[Family: cluster]
This gets the version information of the Anti-Virus engine installed.Inputs
Outputs
[Family: cluster]
Iterate over a list of antivirus objects.Inputs
Outputs
[Family: cluster]
This sets the attributes of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
Modify the attributes of antivirus object.Inputs
Outputs
[Family: cluster]
Create a new antivirus.Inputs
Outputs
[Family: cluster]
This sets the quarantine information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
This sets the version information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
Run an Anti-Virus Update job immediatelyInputs
Outputs
[Family: cluster]
Get the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Get the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Modify the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Get the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Iterate of audit log entriesInputs
Outputs
[Family: cluster]
Modify the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Get AutoSupport time and size limits for the given node and subsystem.Inputs
Outputs
[Family: cluster]
Get AutoSupport time and size limits per subsystem for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify AutoSupport time and size limits per subsystem.Inputs
Outputs
[Family: cluster]
Test connectivity to the AutoSupport destinations for the given node.Inputs
Outputs
[Family: cluster]
Test connectivity to the Autosupport destinations for all nodes.Inputs
Outputs
[Family: cluster]
Get Current Status of AutoSupport Subsystem for all nodes.Inputs
Outputs
[Family: cluster]
Get AutoSupport compliance hash mappingInputs
Outputs
[Family: cluster]
Get AutoSupport compliance hash mappingInputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Get AutoSupport configuration settings for the given node.Inputs
Outputs
[Family: cluster]
Get AutoSupport configuration settings for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify AutoSupport configuration settings for the given node.Inputs
Outputs
[Family: cluster]
Get the list of AutoSupport destinations for the given node.Inputs
Outputs
[Family: cluster]
Get the list of AutoSupport destinations for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records. This sould be equal to the number of nodes in the cluster.Inputs
Outputs
[Family: cluster]
Get a download record for the given AutoSupport.Inputs
Outputs
[Family: cluster]
Get the download records.Inputs
Outputs
[Family: cluster]
Cancel an AutoSupport Transmission.Inputs
Outputs
[Family: cluster]
Get a history record for the given AutoSupport.Inputs
Outputs
[Family: cluster]
Get the history records for the last 50 AutoSupport messages.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Selectively retransmit a previously collected AutoSupport message.Inputs
Outputs
[Family: cluster]
Generate a new AutoSupport messageInputs
Outputs
[Family: cluster]
Generate and send an AutoSupport message with an existing core file.Inputs
Outputs
[Family: cluster]
Generate and send an AutoSupport message with diagnostic content from specified subsystems.Inputs
Outputs
[Family: cluster]
Generate and send an AutoSupport message with diagnostic content from specified subsystems.Inputs
Outputs
[Family: cluster]
Generate a new AutoSupport messageInputs
Outputs
[Family: cluster]
Generate and send an AutoSupport message with performance archives.Inputs
Outputs
[Family: cluster]
Generate and send an AutoSupport message with performance archives.Inputs
Outputs
[Family: cluster]
Generate a Remote Service Processor Log AutoSupport messageInputs
Outputs
[Family: cluster]
Get a detailed manifest for the contents of an AutoSupport.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Get the AutoSupport trigger data for the given node and EMS message.Inputs
Outputs
[Family: cluster]
Get a list of the AutoSupport trigger data for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify the AutoSupport trigger data for the given node and EMS message.Inputs
Outputs
[Family: cluster]
Returns giveback status of all the aggregates in the cluster which are taken over or were given back.Inputs
Outputs
[Family: cluster]
Forces one filer to take over its partner even though the filer detects an error that would otherwise prevent a takeover. For example, normally, if a detached or faulty interconnect cable between the filers causes the filers' NVRAM contents to be unsynchronized, takeover is disabled. However, this will allow the filer to take over its partner despite the unsynchronized NVRAM contents. cf-force-takeover is dangerous and can lead to data corruption; in almost all cases, use cf-takeover instead.Inputs
Outputs
[Family: cluster]
Iterate over a list of cf objects.Inputs
Outputs
[Family: cluster]
Get the host name of the partner. If the name is unknown, It will return partner-unknown.Inputs
Outputs
[Family: cluster]
Initiates a giveback of partner resources. Once the giveback is complete, the automatic takeover capability is disabled until the partner is rebooted. A giveback fails if outstanding CIFS sessions, active system dump processes, or other filer operations makes a giveback dangerous or disruptive.Inputs
Outputs
[Family: cluster]
Get useful information about statistics of hardware assisted takeover functionality.Inputs
Outputs
[Family: cluster]
Get useful information about stats of hw_assist functionality.Inputs
Outputs
[Family: cluster]
Get useful information about the status of hw_assist functionality.Inputs
Outputs
Possible values are:
Possible values are:
[Family: cluster]
Validates the hardware-assisted takeover configuration. functionality.Inputs
Outputs
[Family: cluster]
Enable or disable the high-availability (HA) for this node. A reboot of the node is required for the HA mode to become effective.Inputs
Possible values:
Outputs
[Family: cluster]
Modify the attributes of cf or a group of cf objects.Inputs
Outputs
[Family: cluster]
Disables the takeover capability of this filer in the cluster.Inputs
Outputs
[Family: cluster]
Enables the takeover capability of this filer in the cluster. This spawns a process to enable the serviceInputs
Outputs
[Family: cluster]
Get useful information about the status of the high availability service. If the monitor is not initialized, this returns an error.Inputs
Outputs
[Family: cluster]
Initiates a takeover of the storage partner. Takeover is done asynchronously; status may be monitored by calling the cf-status API and examining the state field. If automatic giveback is enabled then control will be returned to storage partner once it boots up.Inputs
Outputs
[Family: cluster]
Get the takeover status of a node and the takeover status of all its partner aggregates, for all nodes in a cluster.Inputs
Outputs
[Family: vserver]
Commits the snapshots that were started during the preceeding cg-start call that returned the cg-id key, and unfences the volumes that were fenced. If cg-commit API times out, then it means that either too many volumes were specified to the cg-start api or the timeout value for the cg-start api was very small. In this situation, the caller should try to perform the cg-start operation by specifying lesser volumes or by specifying higher timeout value.Inputs
Outputs
[Family: vserver]
Starts the checkpoint cycle for externally synchronized checkpoints in the filer. This operation fences the specified volumes and returns "success" (if successful). If the API returns "success", the call starts a snapshot create operation in these volumes. If the API returns "success", this operation SHOULD be followed by a call to cg-commit (below).This API is not supported on Infinite Volume.
Inputs
Outputs
[Family: vserver]
Create and setup the BranchCache service.Inputs
Outputs
[Family: vserver]
Flush (delete) all the BranchCache hashes that have been generated for a Vserver.Inputs
Outputs
[Family: vserver]
Retrieve information about the BranchCache service.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the per-Vserver BranchCache configurations for the cluster.Inputs
Outputs
[Family: vserver]
Force the generation of BranchCache hashes for a file or path.Inputs
Outputs
[Family: vserver]
Modify the CIFS BranchCache service settingsInputs
Outputs
[Family: vserver]
Remove the BranchCache serviceInputs
Outputs
[Family: vserver]
Get the CIFS name and SID cache configuration of the SVMInputs
Outputs
[Family: vserver]
Modify the CIFS name and SID cache configuration of the specified SVM. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: vserver]
Create a character mapping. This API is not supported for FlexGroups or Vservers with Infinite Volume.Inputs
Outputs
[Family: vserver]
Delete a character mapping. This API is not supported for FlexGroups or Vservers with Infinite Volume.Inputs
Outputs
[Family: cluster, vserver]
Display a character mappingInputs
Outputs
[Family: vserver]
Modify a character mapping. This API is not supported for FlexGroups or Vservers with Infinite Volume.Inputs
Outputs
[Family: cluster, vserver]
Display the Status of Connectivity from Each Node to the CIFS Server for the Given VserverInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of the established CIFS connections.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of servers discovered by the cluster.Inputs
Outputs
[Family: vserver]
Command to trigger re-discovery of servers.Inputs
Outputs
[Family: vserver]
Add to the list of trusted domains for name-mapping searchInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of trusted domains for name-mapping search.Inputs
Outputs
[Family: vserver]
Modify the list of trusted domains for name-mapping searchInputs
Outputs
[Family: vserver]
Remove from the list of trusted domains for name-mapping searchInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-domain-password-schedule objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of cifs-domain-password-schedule object.Inputs
Outputs
[Family: vserver]
Add to a list of preferred domain controllersInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of preferred domain controllers associated with Active Directory domains.Inputs
Outputs
[Family: vserver]
Remove from a list of preferred domain controllersInputs
Outputs
[Family: vserver]
Get the CIFS server domain discovery mode of a VserverInputs
Outputs
[Family: cluster, vserver]
Iterate through the CIFS server domain discovery mode of the clusterInputs
Outputs
[Family: vserver]
Modify the CIFS server domain discovery mode of a VserverInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of discovered trusted domains.Inputs
Outputs
[Family: vserver]
Command to trigger re-discovery of trusted domains.Inputs
Outputs
[Family: cluster, vserver]
Displays CIFS home directory configurationsInputs
Outputs
[Family: vserver]
Modify CIFS home directory configurationsInputs
Outputs
[Family: vserver]
Add a path to the list of paths that will be searched to find a CIFS user's home directory.Inputs
Outputs
[Family: vserver]
Delete a home directory search path. This API is deprecated in Data ONTAP 8.2 and later but retained for backwards compatibility. Use cifs-home-directory-search-path-remove instead of cifs-home-directory-search-path-delete.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-home-directory-search-path objects.Inputs
Outputs
[Family: vserver]
Remove a home directory search path.Inputs
Outputs
[Family: vserver]
Change the position of this path in the list of paths that will be searched to find a CIFS user's home directory.Inputs
Outputs
[Family: vserver]
Create a single local groupInputs
Outputs
[Family: vserver]
Delete a single local groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local groupsInputs
Outputs
[Family: vserver]
Add local users or Active Directory users or groups to a local groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local group membersInputs
Outputs
[Family: vserver]
Remove local users or Active Directory users or groups from a local groupInputs
Outputs
[Family: vserver]
Modify a description of a single local groupInputs
Outputs
[Family: vserver]
Rename a local groupInputs
Outputs
[Family: vserver]
Configure and create a local user, associated with a VserverInputs
Outputs
[Family: vserver]
Delete a single local userInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local usersInputs
Outputs
[Family: cluster, vserver]
Retrieve local users' membership informationInputs
Outputs
[Family: vserver]
Modify a single local userInputs
Outputs
[Family: vserver]
Rename a local userInputs
Outputs
[Family: vserver]
Set password for a local userInputs
Outputs
[Family: cluster, vserver]
Retrieve the NetBIOS Name Service statistics for Vservers in cluster.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-options objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of cifs-options object.Inputs
Outputs
[Family: vserver]
Generate a new password for the CIFS server's machine account and change it in the Windows Active Directory domain.Inputs
Outputs
[Family: vserver]
Reset the CIFS server's machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.Inputs
Outputs
[Family: cluster, vserver]
Display the Status of the Preferred-DCs configured for the Given VserverInputs
Outputs
[Family: vserver]
Add privileges to a local or Active Directory user or groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local groupsInputs
Outputs
[Family: vserver]
Remove privileges from a local or Active Directory user or groupInputs
Outputs
[Family: vserver]
Reset privileges for a local or Active Directory user or groupInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-security objects.Inputs
Outputs
[Family: vserver]
Modify the security configuration of a CIFS server.Inputs
Outputs
[Family: vserver]
Add NetBIOS aliases for the CIFS server nameInputs
Outputs
[Family: vserver]
Configure and setup CIFS services on a Vserver. If joining a domain, this command may take several minutes to complete.Inputs
Outputs
[Family: vserver]
Delete a CIFS server. If the admin-username and admin-password are not specified, the CIFS server's machine account will not be deleted from the Windows Active Directory domain. The deletion of the CIFS server will also delete the CIFS shares associated with it.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of CIFS servers on the cluster and their basic configurations.Inputs
Outputs
[Family: vserver]
Modify the basic properties of a CIFS server. If re-joining the current domain or joining a new one, this command may take several minutes to complete.Inputs
Outputs
[Family: vserver]
Remove NetBIOS aliasesInputs
Outputs
[Family: vserver]
Start a CIFS server on the specified Vserver. The CIFS server must already exist. To create a CIFS server, use cifs-server-create.Inputs
Outputs
[Family: vserver]
Stop a CIFS server on the specified Vserver. Note that established sessions will be terminated and their open files closed. Workstations with cached data will not be able to save those changes, which could result in data loss.Inputs
Outputs
[Family: cluster, vserver]
Close an open CIFS sessionInputs
Outputs
[Family: cluster, vserver]
Close an open CIFS file.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of the opened CIFS files.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of the established CIFS sessions.Inputs
Outputs
[Family: vserver]
Add permissions for a user or group for a defined CIFS share.Inputs
Outputs
[Family: vserver]
Remove permissions for a user or group on a defined CIFS share.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of permissions on defined CIFS shares.Inputs
Outputs
[Family: vserver]
Modify the permissions for a user or group on a defined CIFS share.Inputs
Outputs
[Family: vserver]
Creates a new CIFS share rooted at the specified path.Inputs
Outputs
[Family: vserver]
Deletes the specified CIFS share.Inputs
Outputs
[Family: cluster, vserver]
Gives information about one or more CIFS shares.Inputs
Outputs
[Family: vserver]
Modifies settings of a CIFS share, even if the shares are in use.Inputs
Outputs
[Family: vserver]
Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path. This symbolic link path mapping will be effective on symbolic links that have a prefix match with the value of 'unix-path'. e.g.: if the value of 'unix-path' is '/usr/local/' and there exists a symbolic link on the file system at '/home/user/link' which points to '/usr/local/share/dest'. If a CIFS client accesses the symbolic link 'link', this entry of path mapping would have a prefix match '/usr/local/'. The CIFS client would be redirected to the location pointed to by this path mapping's 'cifs-server', 'share-name' and 'cifs-path' fields.Inputs
Outputs
[Family: vserver]
Delete a CIFS symbolic link path mapping.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of CIFS symbolic link path mappings.Inputs
Outputs
[Family: vserver]
Modify a CIFS symbolic link path mapping parameters.Inputs
Outputs
[Family: vserver]
Find the user's home directory based on user nameInputs
Outputs
[Family: cluster, vserver]
Find the user's home directory based on user nameInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local group membersInputs
Outputs
[Family: cluster, vserver]
Retrieve local users' membership informationInputs
Outputs
[Family: vserver]
Return charmap information for a specified volume.Inputs
Outputs
[Family: vserver]
Set the character mapping on a volumeInputs
Outputs
[Family: cluster, vserver]
gets current date and time from filer.Inputs
Outputs
[Family: cluster, vserver]
Gets current timezone and timezone file version.Inputs
Outputs
[Family: vserver]
Enable autodelete on a file, LUN, or NVMe namespace clone. This command is only supported for flexible volumes.Inputs
Outputs
[Family: vserver]
Get the information about file or LUN clone autodeletionInputs
Outputs
[Family: vserver]
Create a file/sub file, LUN/sub LUN, or NVMe namespace/sub NVMe namespace clone. This command is only supported for flexible volumes.Inputs
Outputs
[Family: vserver]
Add new supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete. This command is only supported for flexible volumes.Inputs
Outputs
[Family: cluster, vserver]
List the clone deletion infoInputs
Outputs
[Family: vserver]
Required minimum size of the file(s) and lun(s) on the specified volume to be deleted with clone-delete.Inputs
Outputs
[Family: vserver]
Remove the no longer supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete. This command is only supported for flexible volumes.Inputs
Outputs
[Family: vserver]
Enable clone split on split disabled entryInputs
Outputs
[Family: cluster, vserver]
Gets information about load on all nodes due to file or LUN clone split operations.Inputs
Outputs
[Family: vserver]
Get the information about unsplit file or LUN clones in a volumeInputs
Outputs
[Family: cluster, vserver]
Create a token to reserve available split load on a node. This token can be used with clone-create api to use up the reserved split load. This will to allow clone creates from getting throttled.Inputs
Outputs
[Family: cluster, vserver]
Delete token(s) to increase the allowed split load by a node.Inputs
Outputs
[Family: cluster, vserver]
Get the information about a specified token.Inputs
Outputs
[Family: cluster, vserver]
Get the information about all reserved tokens.Inputs
Outputs
[Family: cluster, vserver]
Modify the allowed expiry limit for token(s).Inputs
Outputs
[Family: cluster]
Use this API to add new nodes to cluster. Provide only one of node-count, node-ip, or cluster-ips. To watch the progress use cluster-add-node-status-get-iter API. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Get Progress of Cluster Create or Node Add OperationInputs
Outputs
[Family: cluster]
Returns the contact information.Inputs
Outputs
[Family: cluster]
Modifies the contact information.Inputs
Outputs
[Family: cluster]
Start the process to create a cluster using this node. Use cluster-add-node-status-get-iter to track the status of the operation. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Once the cluster create or cluster join operation has been started on this node, use this ZAPI to get the current status of the operation. During cluster join, there is a 1 to 5 second window where the network connection will be unavailable while web services restart. The caller will have to periodically retry until this ZAPI becomes available.Inputs
Outputs
[Family: cluster]
Returns the cluster identity information.Inputs
Outputs
[Family: cluster]
Modifies the cluster identity information.Inputs
Outputs
[Family: cluster]
Start the process of joining this node to a cluster. Join can be done by Cluster IP Address. Only one join operation is supported at a time. Use cluster-create-join-progress-get to track the status of the operation. This API is deprecated as of Data ONTAP 9.2, and the cluster-add-node API should be used instead.Inputs
Outputs
[Family: cluster]
Create a log forwarding configurationInputs
Outputs
[Family: cluster]
Delete a log forwarding configurationInputs
Outputs
[Family: cluster]
Get information about log forwardingInputs
Outputs
[Family: cluster]
Get information about log forwardingInputs
Outputs
[Family: cluster]
Modify the log forwarding configurationInputs
Outputs
[Family: cluster]
Get information about log forwarding statisticsInputs
Outputs
[Family: cluster]
Get information about log forwarding statisticsInputs
Outputs
[Family: cluster]
Returns information about a node in a cluster.Inputs
Outputs
[Family: cluster]
Returns information about nodes in a cluster.Inputs
Outputs
[Family: cluster]
Modifies state of a node in a cluster.Inputs
Outputs
[Family: cluster]
Removes a node from the cluster. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Get zoneinfo informationInputs
Outputs
[Family: cluster]
This commands loads a new set of timezone zoneinfo data to replace the version installed in the cluster.Releases of Data ONTAP software contain the timezone data that is current at the time of release. If a change is made to the timezone between Data ONTAP releases, then an update can be made to the installed data.
For instance, if a change is made to when daylight saving time is observed for a country then an update to cluster zoneinfo data may be required.
Only zoneinfo files provided for use in Data ONTAP should be used with this command.
To update the zoneinfo database do the following:Inputs
Outputs
[Family: cluster]
Get the attributes of the cluster-image.Inputs
Outputs
[Family: cluster]
Check the progress of current image download started by the cluster-image-package-download ZAPI.Inputs
Outputs
[Family: cluster]
Iterate over a list of cluster-image objects.Inputs
Outputs
[Family: cluster]
The cluster-image-get-upgrade-plan API generates an Upgrade Plan and Backout Plan for the specified target image. The target package-version must be provided.Inputs
Outputs
[Family: cluster]
Get information on cluster image update progress for MetroClusterInputs
Outputs
[Family: cluster]
Get information on a node's image update progressInputs
Outputs
[Family: cluster]
The cluster-image-package-delete API removes the given package from the cluster image package repository.Inputs
Outputs
[Family: cluster]
The cluster-image-package-download API downloads the specified package. This API is asynchronous and returns immediately after the download is started. The download progress can be monitored by calling cluster-image-get-download-progress ZAPI. The package-url string must be provided.Inputs
Outputs
[Family: cluster]
Abort an ongoing package download operation.Inputs
Outputs
[Family: cluster]
The cluster-image-package-local-get API retrieves detailed information about a package located in the cluster image package repository.Inputs
Outputs
[Family: cluster]
Get multiple locally available package recordsInputs
Outputs
[Family: cluster]
The cluster-image update API validates, installs prerequisite component updates, and installs Data ONTAP to all specified nodes within a cluster in a nondisruptive manner. Since validation, which is run as part of update, requires a minimum of 30 seconds, the API should be called with sufficient timeout value.Inputs
Outputs
[Family: cluster]
The cluster-image-update-cancel API cancels a package update that is currently in progress. The update will stop and be canceled at the end of the current logical operation. Logical operations are: - After the cluster validation, or prerequisite update phase - After the update of each HA pair - Immediately, if the update is currently paused After the successful completion of this command the update will be removed from the package update queue. The cancellation will be logged in the update history.Inputs
Outputs
[Family: cluster]
Get multiple update history records.Inputs
Outputs
[Family: cluster]
Get multiple update logsInputs
Outputs
[Family: cluster]
The cluster-image-update-pause API pauses an update that is in progress. The update will pause at the end of the current logical operation. Logical operations include: - After the cluster validation, or prerequisite update phase - After the update of each node After the successful completion of this command the currently running update will be paused at the end of the current logical operation.Inputs
Outputs
[Family: cluster]
This API provides the status of all phases of update that is in progress.Inputs
Outputs
[Family: cluster]
Get information on cluster image update progressInputs
Outputs
[Family: cluster]
The cluster-image-update-resume API resumes a package update that is currently paused. If the update is not in the paused state the API call will fail. After the successful completion of this command the current paused update will resume from the last successful operation completed.Inputs
Outputs
[Family: cluster]
The cluster-image-validate API validates the various logical and physical components of a cluster to ensure that a nondisruptive update can occur. Since validation requires a minimum of 30 seconds, the API should be called with sufficient timeout value.Inputs
Outputs
[Family: cluster]
Cancel the outstanding offer to authenticate with a peer clusterInputs
Outputs
[Family: cluster]
Return the specified peer cluster relationship authentication offer informationInputs
Outputs
[Family: cluster]
Returns a list of cluster peer relationship authentication offersInputs
Outputs
[Family: cluster]
Modifies the cluster peer relationship authentication offer, as created by the cluster-peer-create or cluster-peer-modify APIs.Inputs
Outputs
[Family: cluster]
Terminate a current peering connectionInputs
Outputs
[Family: cluster]
Return information about the specified connection to the specified cluster peerInputs
Outputs
[Family: cluster]
Returns a list of connections to cluster peersInputs
Outputs
[Family: cluster]
Create a cluster peer relationship and, optionally, an offer to authenticate with a peer. Initiate an authenticated relationship, and an offer to authenticate with a peer, by including the passphrase parameter. Initiate an unauthenticated relationship by omitting the passphrase and, optionally, including a user-name and password.Inputs
Outputs
[Family: cluster]
Delete a cluster peer relationship as well as any an offer to authenticate with the peer cluster.Inputs
Outputs
[Family: cluster]
Return the specified peer cluster relationship informationInputs
Outputs
[Family: cluster]
Returns a list of cluster peer relationshipsInputs
Outputs
[Family: cluster]
Get the health of the specified peer nodeInputs
Outputs
[Family: cluster]
Get the health of all local and peer nodes sequentiallyInputs
Outputs
[Family: cluster]
Modifies a cluster peer relationship, optionally also creating an offer to authenticate with a peer.Inputs
Outputs
[Family: cluster]
Modify the local name for a cluster peer.Inputs
Outputs
[Family: cluster]
Ping the specified peer nodes. Ping operations take place between a node in a cluster and a node in a remote cluster. The originating node is the node which initiates the ping operation and the destination cluster and node specify the remote node which is the target of the ping.Inputs
Outputs
[Family: cluster]
Return the cluster peering policy configuration.Inputs
Outputs
[Family: cluster]
Modify the cluster peering policy configuration.Inputs
Outputs
[Family: cluster]
Cluster-switch health-monitor no-ontap-dependency(NOD) configuration setupInputs
Outputs
[Family: cluster]
Add information about a cluster switch or management switch.Inputs
Outputs
[Family: cluster]
Delete information about a cluster switch or management switch.Inputs
Outputs
[Family: cluster]
(cluster-swt-get-iter is now deprecated. Use cluster-switch-get-iter instead.)Display the configuration for cluster and management switches.Inputs
Outputs
[Family: cluster]
Modify information about a switch's configuration.Inputs
Outputs
[Family: cluster]
Returns cluster switch polling interval information.Inputs
Outputs
[Family: cluster]
Modify cluster switch polling interval information.Inputs
Outputs
[Family: cluster]
Iterate over a list of Cluster Switch Information objects.Inputs
Outputs
[Family: cluster]
Copy a configuration backup. A job will be queued to copy the configuration backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Create a configuration backup. A job will be queued to create the configuration backup in the background. Creation of configuration backup may take several minutes. This ZAPI creates an on demand backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Delete a configuration backup.Inputs
Outputs
[Family: cluster]
Download a configuration backup from a URL.Inputs
Outputs
[Family: cluster]
Return information about a specified configuration backup.Inputs
Outputs
[Family: cluster]
Return a list of configuration backups in the cluster.Inputs
Outputs
[Family: cluster]
Rename a configuration backup. Renamed backup stays on the same node.Inputs
Outputs
[Family: cluster]
Return information about the configuration backup settings.Inputs
Outputs
[Family: cluster]
Modify the settings for configuration backup operations.Inputs
Outputs
[Family: cluster]
Modify the password for destination URL.Inputs
Outputs
[Family: cluster]
Upload a configuration backup to a URL.Inputs
Outputs
[Family: cluster]
Trigger a coredump via the Service ProcessorInputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
This command is removed starting from ONTAP 9.0.Inputs
Outputs
[Family: cluster]
Return alert definitionInputs
Outputs
[Family: cluster]
Iterate over a list of Alert Definition objects.Inputs
Outputs
[Family: cluster]
Return a subsystem alertInputs
Outputs
[Family: cluster]
Iterate over a list of Alert Information objects.Inputs
Outputs
[Family: cluster]
Acknowledge/suppress an alertInputs
Outputs
[Family: cluster]
Return the system health framework configurationInputs
Outputs
[Family: cluster]
Iterate over a list of Health Monitor Configuration objects.Inputs
Outputs
[Family: cluster]
Delete subsystem alertInputs
Outputs
[Family: cluster]
Return policy definitionInputs
Outputs
[Family: cluster]
Iterate over a list of Policy Definition objects.Inputs
Outputs
[Family: cluster]
Enable/disable policyInputs
Outputs
[Family: cluster]
Return the overall system healthInputs
Outputs
[Family: cluster]
Create a new Subscriptions for Notifications.Inputs
Outputs
[Family: cluster]
Return system health subscriptionInputs
Outputs
[Family: cluster]
Iterate over a list of Subscriptions for Notifications objects.Inputs
Outputs
[Family: cluster]
Modify system health subscriptionInputs
Outputs
[Family: cluster]
Get the attributes of the Health Monitor Subsystem Status.Inputs
Possible values:
Outputs
[Family: cluster]
Iterate over a list of Health Monitor Subsystem Status objects.Inputs
Outputs
[Family: cluster]
Modify system health subsystemInputs
Possible values:
Outputs
[Family: cluster]
Fail a file system disk. Removes the specified file system disk from the RAID configuration, spinning the disk down when removal is complete. disk fail is used to remove a file system disk that may be logging excessive errors and requires replacement. Note that if optional input parameter 'is-immediate' is true, the specified disk will be immediately failed out, and the RAID group to which the disk belongs will enter degraded mode (meaning a disk is missing from the RAID group). If a spare disk at least as large as the disk being removed is available, the contents of the disk being removed will be reconstructed onto that spare disk. If 'is-immediate' options is false or not specified, system will prefail the disk and its content will be copied to a replacement disk if a suitable spare disk is available, and afterwards the prefailed disk will be failed out. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The disk being failed is marked as ``broken'', so that if it remains in the disk shelf, it will not be used by the filer as a spare disk. If the disk is moved to another filer, that filer will use it as a spare. This is not a recommended course of action, as the reason that the disk was failed may have been because it needed to be replaced. NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.Inputs
Outputs
[Family: cluster]
Remove a spare disk. Removes the specified spare disk from the RAID configuration, spinning the disk down when removal is complete. You can use disk remove to remove a spare disk so that it can be used by another filer (as a replacement for a failed disk or to expand file system space). NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.Inputs
Outputs
[Family: cluster]
Initiate replacing a file system disk with an appropriate spare disk. Uses Rapid RAID Recovery to copy data from the source file system disk to the destination spare disk. Roles of disks are reversed at the end of that process. The spare disk will replace the file system disk in the RAID group and the file system disk will become a spare. This interface returns as soon as possible while disk replace starts in the background. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Note: The operation performs limited error checking. Disk replace starts asynchronously in the background, and it can fail even if ZAPI reports success.Inputs
Outputs
[Family: cluster]
Abort disk replace.Inputs
Outputs
[Family: cluster]
Assigns ownership of a disk. The normal usage is when the disk is unowned, or to assign a disk to a pool.Inputs
Outputs
[Family: cluster]
Get sanown filer information.Inputs
Outputs
[Family: cluster]
Get sanown disk information. This API is not supported as of Data ONTAP 8.2. Use storage-disk-get-iter instead.Inputs
Outputs
[Family: cluster]
Changes ownership on disks already belonging to an owner.Inputs
Outputs
[Family: cluster]
Removes ownership information on a disks provided by disk-list.Inputs
Outputs
[Family: cluster]
Unfail a disk in the broken pool, by clearing its FDR (Failed Disk Registry) entry and unfailing it at the Storage Layer, as necessary. If the "make-spare" option is set to B_TRUE, the disk is returned to the spare pool. Otherwise, label assimilation will bring the disk back according to its on-disk labels, with one of four possible outcomes. 1. Disk becomes a spare. This is the common case. The disk becomes a spare upon unfail, because its parent volume is complete and online. 2. Disk is assimilated into former volume. This is a recovery scenario. The disk is brought back into an existing volume, which may result in this volume coming back online. 3. Disk is assimilated into a new partial volume. This may occur in the rare case that the disk's former volume was destroyed or moved. 4. Disk returned to broken pool. This is the case if a fatal error occurs in process of unfailing the disk.Inputs
Outputs
[Family: cluster]
Start disk firmware download process to update firmware on disks. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on disks that do not have the latest firmware revision. The firmware revision on the disk can be monitored via the disk-list-info API.Inputs
Outputs
[Family: cluster]
Set up all non-zeroed spares owned by the filer to start zeroing. This operation is asynchronous, and therefore returns no errors that might occur when the zeroing operation actually starts, which could be several seconds after this API operation completes. Zeroing progress can be monitored via the disk-list-info API. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The "zeroing-percent" element of disk-detail-info is returned if disk zeroing has started, and "is-zeroed" returns TRUE once the zeroing has completed (or, if zeroing wasn't necessary in the first place).Inputs
Outputs
[Family: cluster]
Return data key ID, FIPS key ID and protection mode of a self-encrypting disk.Inputs
Outputs
[Family: cluster]
Return data key ID, FIPS key ID and protection mode of one or more self-encrypting disks.Inputs
Outputs
[Family: cluster]
The disk-encrypt-modify API alters encryption parameters on a self-encrypting disk (SED).The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.
Inputs
Outputs
[Family: cluster]
The disk-encrypt-modify-iter API alters encryption parameters on one or more self-encrypting disks (SEDs).The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.
Inputs
Outputs
[Family: cluster]
The disk-encrypt-sanitize API cryptographically erases a self-encrypting disk (SED) that is in the spare or broken state.The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.
Inputs
Outputs
[Family: cluster]
The disk-encrypt-sanitize-iter API cryptographically erases one or more self-encrypting disks that are in the spare or broken state.The API output <results status="passed"> indicates only that the operation has started. Monitor operation progress using the disk-encrypt-status-get or disk-encrypt-status-get-iter API.
Inputs
Outputs
[Family: cluster]
Return information about the latest self-encrypting disk command for a node.Inputs
Outputs
[Family: cluster]
Return information about the latest self-encrypting disk command for one or more nodes.Inputs
Outputs
[Family: vserver]
This API is used by SnapDrive to log SnapDrive specific events occurring on a host system to the the appliance and optionally use the appliance to generate an autosupport message. This event information will be encapsulated in an app.log.x EMS event based on error level. If auto-support is true, an autosupport message will be sent from the filer.Inputs
Outputs
[Family: cluster]
Return the EMS Configuration.Inputs
Outputs
[Family: cluster]
Modify the EMS Configuration.Inputs
Outputs
[Family: cluster]
Modify the password for proxy serverInputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Creates an EMS destination.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Deletes the specified EMS destination.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Deletes several EMS destinations.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return the specified EMS destination information.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information on EMS destinations.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies the specified EMS destination.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies several EMS destinations.Inputs
Outputs
[Family: cluster]
Return information on several EMS messages.Inputs
Outputs
[Family: cluster]
Copy an Event filter including all its rulesInputs
Outputs
[Family: cluster]
Create a new event filter.Inputs
Outputs
[Family: cluster]
Delete one or more existing event filters. To delete the event notifications associated with the filter as well, set the force flag.Inputs
Outputs
[Family: cluster]
Iterate over a list of event filters.Inputs
Outputs
[Family: cluster]
Rename an Event filterInputs
Outputs
[Family: cluster]
Add a rule to an event filterInputs
Possible values:
Default: *
Possible values:
Default: *
Outputs
[Family: cluster]
Delete a rule for an event filterInputs
Outputs
[Family: cluster]
Reorder the rules based on the new position for a given ruleInputs
Outputs
[Family: cluster]
Test an event filterInputs
Outputs
[Family: cluster]
Create an event notificationInputs
Outputs
[Family: cluster]
Check connectivity to an event notification destinationInputs
Outputs
[Family: cluster]
Create an event notification destinationInputs
Outputs
[Family: cluster]
Delete one or more existing event destinationsInputs
Outputs
[Family: cluster]
Returns information about one or more event notification destinations. The fields is-server-ca-present, certificate-authority, certificate-serial and is-certificate-valid are only applicable for a destination of type 'rest-api' and the destination being an HTTPS destination.Inputs
Outputs
[Family: cluster]
Modify one or more event notification destinationsInputs
Outputs
[Family: cluster]
Delete one or more event notificationsInputs
Outputs
[Family: cluster]
Returns information about one or more event notificationsInputs
Outputs
[Family: cluster]
Return EMS messages sent to a destination.Inputs
Outputs
[Family: cluster]
Modify one or more event notificationsInputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete an individual mail history entry.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete mail history entries.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return an individual mail history entry.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information mail history.Inputs
Outputs
[Family: cluster]
Return an EMS message.Inputs
Outputs
[Family: cluster]
Return EMS messages.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Add EMS Destinations.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return the specified EMS route information. In general, specifying the severity input parameter is not needed. If specified, it must match that of the event identified by the message-name input parameter.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information on several EMS routes.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies the specified EMS route.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Modifies several EMS route.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Remote EMS Destinations.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete an individual SNMP history entry.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Delete SNMP history entries.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return an individual SNMP history entry.Inputs
Outputs
[Family: cluster]
(This interface has been deprecated. It may be removed from a future release of Data ONTAP)-Return information SNMP history.Inputs
Outputs
[Family: cluster]
Return information on an EMS message.Inputs
Outputs
[Family: cluster]
Return information on EMS messages.Inputs
Outputs
[Family: cluster]
Returns the sensors information from the environmental subsystem.Inputs
Outputs
[Family: cluster, vserver]
Shows the access information for supplied clientInputs
Outputs
[Family: vserver]
Create an Export policy configuration.Inputs
Outputs
[Family: vserver]
Delete an Export policy configuration.Inputs
Outputs
[Family: vserver]
Get an Export policy configuration.Inputs
Outputs
[Family: cluster, vserver]
Get a group of Export policy configurations.Inputs
Outputs
[Family: vserver]
Rename an Export policyInputs
Outputs
[Family: vserver]
Add list of clientmatch strings to an existing export-policy ruleInputs
Outputs
[Family: vserver]
Create an Export rule configuration.Inputs
Outputs
[Family: vserver]
Delete an Export rule configuration.Inputs
Outputs
[Family: vserver]
Get an Export rule configuration.Inputs
Outputs
[Family: cluster, vserver]
Obtain the default values for Export rule configurationInputs
Outputs
[Family: cluster, vserver]
Get a group of Export rule configurations.Inputs
Outputs
[Family: vserver]
Modify an Export rule configuration.Inputs
Outputs
[Family: vserver]
Remove clientmatch strings from an existing export-policy ruleInputs
Outputs
[Family: vserver]
Move a rule to the specified indexInputs
Outputs
[Family: cluster]
Get the NFS Exports Access Cache Refresh Periods.This API is deprecated in Data ONTAP 9.0.0 and later.Inputs
Outputs
[Family: cluster]
Modify the NFS Exports Access Cache Refresh Periods. This API is deprecated in Data ONTAP 9.0.0 and later.Inputs
Outputs
[Family: vserver]
Get the exports access cache configuration for the given Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of Vservers for exports access cache configuration.Inputs
Outputs
[Family: vserver]
Modify the exports access cache configuration for the given Vserver.Inputs
Outputs
[Family: cluster]
Call the corresponding adapter driver disable function to bring the adapter offline. Under some circumstances an adapter can not be put offline. (e.g. when the adapter is being used by the RAID sub-system to provide disks in a volume). In some cases, manual intervention is required. When this happens, an appropriate error messages is returned.Inputs
Outputs
[Family: cluster]
Call the corresponding adapter driver enable function to bring the adapter online. Under some circumstances an adapter can not be brought online. (e.g. when that adapter is in the UNCONFIGURED state, or when there is no cable attached to the adapter port). When this happens, an appropriate error messages is returned.Inputs
Outputs
[Family: cluster]
Iterate over a list of fc objects.Inputs
Outputs
[Family: cluster]
fc-config-set-adapter-fc-type changes the adapter driver and/or configuration state. Each configurable adapter has an adapter-type and adapter-state. The adapter-type indicates which driver is attached to the adapter, the adapter-state indicates what the configuration state of the adapter is. The fc-type is used to modify both the adapter-type and the adapter-state. After setting the adapter fc-type a filer reboot is sometimes needed to make the change effective. Use fc-config-list-info to determine if a filer reboot is needed.Inputs
Outputs
[Family: cluster]
Bring a Fibre Channel target adapter offline. The adapter may not be offline immediately after the call returns, it may take up to a few seconds for the adapter to change state. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. adapter to change state. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.Inputs
Outputs
[Family: cluster]
Bring a Fibre Channel target adapter online. The adapter may not be online immediately after the call returns, it may take up to a few seconds for the adapter to initialize. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.Inputs
Outputs
[Family: cluster]
Iterate over the list of physical FC adapters.Inputs
Outputs
[Family: cluster]
Sets the speed on the Fibre Channel target adapter. It can be configured to run at 1Gb, 2Gb, 4Gb, 8Gb, 10Gb, 16Gb or to auto negotiate. The 10Gb adapter only supports the 10Gb speed. The 16Gb adapter only supports speeds of 16Gb, 8Gb, and 4Gb. The 8Gb adapter only supports speeds of 8Gb, 4Gb, and 2Gb. The 4Gb adapter only supports speeds of 4Gb, 2Gb, and 1Gb. If the adapter is online it must be brought offline before setting the speed, and then online in order for a new speed to take effect. This may temporarily disrupt fcp service on the target adapter.Inputs
Outputs
[Family: cluster]
Iterate over a list of fcp objects.Inputs
Outputs
[Family: cluster, vserver]
List all initiators connected to FCP target LIFs.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of FCP Target Logical Interfaces (LIF).Inputs
Outputs
[Family: cluster, vserver]
Iterates over the list of entries in the fabric name server database.Inputs
Outputs
[Family: vserver]
Get the current FCP World Wide Node Name (WWNN). This WWNN name is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. In Data ONTAP 7-Mode, this is the WWNN of the individual storage system. In "single_image" cfmode, the WWNN of the system and its high availability partner will be the same. In Data ONTAP Cluster-Mode, this is the WWNN of the Vserver FCP Service.Inputs
Outputs
[Family: vserver]
Set the current FCP World Wide Node Name (WWNN). This WWNN is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. The provided WWNN must also be within one of the allowed vendor-registered namespaces unless the force parameter is specified. In Data ONTAP 7-Mode, all Fibre Channel adapters must be offline. The allowed vendor namespace is "50:0a:09:80:8X:XX:XX". Changes will take place when the adapters are brought online. In Data ONTAP Cluster-Mode, the FCP service must be offline. The allowed vendor namespace is one of following:Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of FCP ping igroup results objects.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of FCP ping by FCP initiator objects.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of valid Fibre Channel target port names on a Vserver's FCP LIFs.Inputs
Outputs
[Family: vserver]
Set a valid but unused port name on a Fibre Channel target interface.Inputs
Outputs
[Family: vserver]
Create an FCP Service in a Vserver. Each Vserver requires an online FCP Service in order to serve data via the Fibre Channel protocol.Inputs
Outputs
[Family: vserver]
Destroy the FCP Service in a Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of FCP Services.Inputs
Outputs
[Family: vserver]
Starts FCP service. When FCP service is started, the adapters are brought online. The service will be available once the call returns with success. The adapters however, may not be available immediately after the call, it may take up to a few seconds for the adapters to initialize.Inputs
Outputs
[Family: vserver]
Get status of the FCP service, whether or not it is running.Inputs
Outputs
[Family: vserver]
Stops FCP service. When FCP service is stopped, the adapters are brought offline. The service will be unavailable once the call returns with success.Inputs
Outputs
[Family: cluster, vserver]
Iterates over the list of FCP topology interconnect elements.Inputs
Outputs
[Family: cluster]
Iterates over the list of entries in the fabric name server database.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of assigned World Wide Port Name (WWPN) aliases.Inputs
Outputs
[Family: vserver]
Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.Inputs
Outputs
[Family: vserver]
Set an alias for a World Wide Port Name of an initiator that might login to the target.Inputs
Outputs
[Family: cluster]
Iterates over the list of entries in the fabric name server database.Inputs
Outputs
[Family: cluster]
Get the link state of a specific adapter on this system.Inputs
Outputs
[Family: cluster, vserver]
Returns status information for managed features.Inputs
Outputs
[Family: cluster]
Returns feature usage information for DATA ONTAP features. The feature usage information is reported on a per controller node basis.Inputs
Outputs
[Family: cluster]
Returns feature usage summary information for DATA ONTAP features. The feature usage information is reported on a per controller node basis.Inputs
Outputs
[Family: cluster]
Manage the association of QoS policy group to a specified file. QoS Policy groups define measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated. In Data ONTAP 8.2 hierarchical QoS is not supported i.e. QoS policy groups cannot be assigned to multiple objects in the file's storage hierarchy - such as the parent LUN, volume or Vserver.Inputs
Outputs
[Family: cluster]
compact dataInputs
Outputs
[Family: vserver]
Create a directory.Inputs
Outputs
[Family: vserver]
Create a symlink.Inputs
Outputs
[Family: vserver]
Delete a directory.Inputs
Outputs
[Family: vserver]
Delete a file.Inputs
Outputs
[Family: cluster, vserver]
The file-fingerprint-abort API can be used to abort an ongoing fingerprint operation. This api only aborts the fingerprint operations that have been started and have not finished. You identify the session-id with this API, and it aborts the fingerprint operation that is associated with that particular session-id. You must specify session-id when using file-fingerprint-abort.Inputs
Outputs
[Family: cluster, vserver]
The file-fingerprint-dump API returns the fingerprint information for a file. The session-id must be specified when using the file-fingerprint-dump API.This is the session-id of the fingerprint operation that is returned when a fingerprint operation is started using the file-fingerprint-start API. If the fingerprint operation is complete, it will also show the complete fingerprint information for the file.Inputs
Outputs
[Family: cluster, vserver]
The file-fingerprint-get-iter API returns information for one or several fingerprint operations. We need to specify either session-id or vserver-name and volume-name with the file-fingerprint-get-iter API. When queried with session-id, the file-fingerprint-get-iter API returns the progress of the fingerprint operation with the specified session-id. When queried with vserver-name and volume-name, the file-fingerprint-get-iter API returns the progress of all the fingerprint operations running on that particular volume.Inputs
Outputs
[Family: vserver]
The file-fingerprint-start API is used to start the fingerprint computation a file. The fingerprint computation is started on the file, and a session-id is returned. This session-id is an unique identifier for the fingerprint operation. To start the fingerprint computation on a file, the following parameters should be compulsarily specified:Inputs
Outputs
[Family: vserver]
Obtains the file information or properties.Inputs
Outputs
[Family: vserver]
Queries the space reservation settings for the named file.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Return ranges of holes in a fileInputs
Outputs
[Family: vserver]
Get information about all the files associated with an inode in a volume.Inputs
Outputs
[Family: vserver]
list of files in a given directory.Inputs
Outputs
[Family: vserver]
Punch hole in the file. Hole punching involves reclaiming of blocks in a file by unallocating them and then direct or indirect blocks can be made to point to 0.Inputs
Outputs
[Family: vserver]
Read data from a named file. API will fail if length exceeds 1 MB. This API should only be used on normal files or streams associated with files. The results for other file types such as LUNs is undefined.Inputs
Outputs
[Family: vserver]
Read the contents of a symlink.Inputs
Outputs
[Family: vserver]
Rename a file or directory. Note that this API cannot be used to rename to a different volume.Inputs
Outputs
[Family: vserver]
Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Truncate a file. Any data past the truncation point will be lost, of course.Inputs
Outputs
[Family: vserver]
Reports unique bytes held in a file.Inputs
Outputs
[Family: vserver]
Used to poll and retrieve results for a previous file-usage-start call. EINPROGRESS indicates that the background job has not finished yet.Inputs
Outputs
[Family: vserver]
Starts a background job to compute unique bytes held in a file. The result can be obtained by passing the cookie to file-usage-result-get call.Inputs
Outputs
[Family: vserver]
Write data into a named file. If the file/stream does not previously exist, it will be created - the owner of the file will be root and it will be readable but not writable by non-root users. API will fail if data exceeds 1 MB. This API should only be used on normal files or streams associated with files. The results for other file types such as LUNs is undefined.Inputs
Outputs
[Family: vserver]
Gives information about the maximal access for the mentioned user on given path.Inputs
Outputs
[Family: vserver]
Returns security information of a file/folderInputs
Outputs
[Family: vserver]
Creates a new NTFS security descriptorInputs
Outputs
[Family: vserver]
Add a discretionary access control entry to NTFS security descriptor.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more discretionary access control entriesInputs
Outputs
[Family: vserver]
Modify a discretionary access control entry of a file security descriptorInputs
Outputs
[Family: vserver]
Remove a discretionary access control entry from NTFS security descriptor.Inputs
Outputs
[Family: vserver]
Deletes an NTFS security descriptor informationInputs
Outputs
[Family: cluster, vserver]
Returns information about one or more NTFS security descriptorInputs
Outputs
[Family: vserver]
Modifies an NTFS security descriptorInputs
Outputs
[Family: vserver]
Add a system/audit access control entry to NTFS security descriptor.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more system/audit access control entriesInputs
Outputs
[Family: vserver]
Modify an system/audit access control entry of a file security descriptorInputs
Outputs
[Family: vserver]
Remove an system/audit access control entry from NTFS security descriptor.Inputs
Outputs
[Family: vserver]
Creates a new file/folder security policy configuration. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: vserver]
Deletes a file/folder security policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more security policies. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: vserver]
Add a file security policy task. A task maps security descriptor with a file or folder.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more policy tasks. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: vserver]
Modify a file security policy taskInputs
Outputs
[Family: vserver]
Remove a task from the policy of a vserver.Inputs
Outputs
[Family: vserver]
Removes SLAG from the specified volume or qtree path.Inputs
Outputs
[Family: vserver]
Apply security descriptors on files and directories defined in a policy to a VserverInputs
Outputs
[Family: vserver]
Create audit configuration for a VserverInputs
Outputs
[Family: vserver]
Show Audit configuration details for a VserverInputs
Outputs
[Family: cluster, vserver]
Show Audit configuration details for all VserversInputs
Outputs
[Family: cluster]
Return the total number of recordsInputs
Outputs
[Family: vserver]
Modify audit configuration for a VserverInputs
Outputs
[Family: vserver]
Disable Auditing for specified VserverInputs
Outputs
[Family: vserver]
Enable Auditing for specified Vserver.Events on FlexGroup volumes will not be emitted to the audit log.
Inputs
Outputs
[Family: vserver]
Disable Audit Configuration for specified vserverInputs
Outputs
[Family: vserver]
Repair the audit infrastructureInputs
Outputs
[Family: vserver]
Rotate audit log for specified vserverInputs
Outputs
[Family: cluster]
Get threshold profiles available in Flash Management Module.Inputs
Outputs
[Family: cluster]
Iterate over a list of Flash Cache threshold profiles objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of Flash Cache device info objects.Inputs
Outputs
[Family: cluster]
Get a collection of Flash Cache device info objects.Inputs
Outputs
[Family: cluster]
Create a new flexcache-cache-policy.Inputs
Outputs
[Family: cluster]
Delete an existing flexcache-cache-policy object.Inputs
Outputs
[Family: cluster]
Get the attributes of the flexcache-cache-policy.Inputs
Outputs
[Family: cluster]
Iterate over a list of flexcache-cache-policy objects.Inputs
Outputs
[Family: cluster]
Modify the attributes of flexcache-cache-policy object.Inputs
Outputs
[Family: cluster, vserver]
Retrieve connected cache information. This must be run at the origin cluster.Inputs
Outputs
[Family: cluster]
Create cluster-wide caching for a given volume.Inputs
Outputs
[Family: vserver]
Create a cache relationship. This must be run at the cache cluster.Inputs
Outputs
[Family: cluster]
Get recommended FlexCache sizeInputs
Outputs
[Family: cluster]
Delete cluster-wide caching for a given volume.Inputs
Outputs
[Family: vserver]
Delete a cache relationship. This must be run at the cache cluster. A job will be spawned to operate on the flexcache and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Get the attributes of the flexcache.Inputs
Outputs
[Family: cluster, vserver]
Get a set of cache relationships. This must be run at the cache cluster.Inputs
Outputs
[Family: cluster]
Get the cluster-wide attributes of FlexCache.Inputs
Outputs
[Family: cluster]
Modify the cluster-wide attributes of FlexCache.Inputs
Outputs
[Family: vserver]
Cleanup cache relationship. This must be run at the origin cluster.Inputs
Outputs
[Family: cluster]
Get the capacity used by FlexCacheInputs
Outputs
[Family: vserver]
Disables a specific named policy.Inputs
Outputs
[Family: vserver]
Enables a specific named policy. The operation will fail if the policy doesn't exist.Inputs
Outputs
[Family: cluster, vserver]
Returns passthrough-read connection status information.Inputs
Outputs
[Family: vserver]
Create a policy.Inputs
Outputs
[Family: vserver]
Delete a policy.Inputs
Outputs
[Family: vserver]
Create FPolicy Event.Inputs
Outputs
[Family: vserver]
Delete FPolicy event.Inputs
Outputs
[Family: cluster, vserver]
Get a list of rows for FPolicy event options. FPolicy event is consist of protocol, file operations, vo lume operation and filters.Inputs
Outputs
[Family: vserver]
Set FPolicy event options. FPolicy event is consist of protocol, file operation, volume operation and f ilters.Inputs
Outputs
[Family: vserver]
Create an external engine.Inputs
Outputs
[Family: vserver]
Delete an external engine.Inputs
Outputs
[Family: cluster, vserver]
Returns information on external engines.Inputs
Outputs
[Family: vserver]
Modify an external engine. External engine can be modified only when none of the enabled policies are using it.Inputs
Outputs
[Family: cluster, vserver]
Returns information about policies.Inputs
Outputs
[Family: vserver]
Modify a policy.Inputs
Outputs
[Family: vserver]
Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.Inputs
Outputs
[Family: vserver]
Delete a scope.Inputs
Outputs
[Family: cluster, vserver]
Get a list of rows for FPolicy scope options. FPolicy Scope consists of share, volume, export policy, volume, file extention.Inputs
Outputs
[Family: vserver]
Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.Inputs
Outputs
[Family: cluster, vserver]
Returns FPolicy policy status information.Inputs
Outputs
[Family: vserver]
Make a connection to FPolicy serverInputs
Outputs
[Family: vserver]
Terminate connection to FPolicy serverInputs
Outputs
[Family: cluster, vserver]
Returns FPolicy server status information.Inputs
Outputs
[Family: cluster, vserver]
Get the list of entries of the applied GPO rules, organized on a per-Vserver basis.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the Vserver's group policy configuration.Inputs
Outputs
[Family: cluster, vserver]
Get a list of entries of the GPO RSoP(Resultant Set of Policy) data, organized on a per-Vserver basis.Inputs
Outputs
[Family: vserver]
Change the Vserver's group policy configuration.Inputs
Outputs
[Family: cluster, vserver]
Applied Restricted Group SettingsInputs
Outputs
[Family: cluster, vserver]
Defined Restricted Group Settings in DCInputs
Outputs
[Family: vserver]
Download and apply the latest version of the group policy defined in Active Directory.Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Create a new group mapping for a Vserver.
Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Delete an existing group mapping entry.
Inputs
Outputs
[Family: cluster, vserver]
This API is no longer supported as of ONTAP 9.5.0.Retrieve the list of group mappings in the cluster.
Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Insert a group mapping into the table at a specified position.
Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Modify an existing group mapping entry.
Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Swap the position of one group mapping with another. The position is the place in the sequence of group mappings in which the mappings are applied.
Inputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect device auto-reset configuration informationInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect channel statusInputs
Outputs
[Family: cluster]
Clear high-availability interconnect port counters of the selected nodeInputs
Outputs
[Family: cluster]
Clear high-availability interconnect port symbol errors of the selected nodeInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect device configuration informationInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect connection statusInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect binary firmware image information residing in the flash card attached to adapterInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect binary firmware image information residing in the systemInputs
Outputs
[Family: cluster]
Verify high-availability interconnect binary firmware image residing in flash card attached to adapter on the selected nodeInputs
Outputs
[Family: cluster]
Verify high-availability interconnect binary firmware image residing in system on the selected nodeInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect device flush informationInputs
Outputs
[Family: cluster]
Get high-availability interconnect device auto-reset configuration information of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect channel status of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect device configuration information of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect connection status of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect binary firmware image information residing in the flash card attached to adapter of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect binary firmware image information residing in the system of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect device flush information of the selected nodeInputs
Outputs
[Family: cluster]
Get basic nvram configuration information of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect device out-of-order delivery information of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect performance statistics of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect device port information of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect device scatter-gather list entry statistics of the selected nodeInputs
Outputs
[Family: cluster]
Get high-availability interconnect software timeout values of the selected nodeInputs
Outputs
[Family: cluster]
Turn off selected interconnect link on the selected nodeInputs
Outputs
[Family: cluster]
Turn on selected interconnect link on the selected nodeInputs
Outputs
[Family: cluster]
Change high-availability interconnect device auto-reset configuration of the selected nodeInputs
Outputs
[Family: cluster]
Change high-availability interconnect software timeout values of the selected nodeInputs
Outputs
[Family: cluster]
Reset high-availability interconnect device of the selected nodeInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their basic nvram configuration informationInputs
Outputs
[Family: cluster]
Clear high-availability interconnect device out-of-order delivery error statistics of the selected nodeInputs
Outputs
[Family: cluster]
Clear high-availability interconnect device out-of-order delivery performance statistics of the selected nodeInputs
Outputs
[Family: cluster]
Disable high-availability interconnect device out-of-order delivery statistics collection for the selected nodeInputs
Outputs
[Family: cluster]
Enable high-availability interconnect device out-of-order delivery statistics collection for the selected nodeInputs
Outputs
[Family: cluster]
Disable coalescing work requests on high-availability interconnect device of the selected nodeInputs
Outputs
[Family: cluster]
Enable coalescing work requests on high-availability interconnect device of the selected nodeInputs
Outputs
[Family: cluster]
Send diagnostic buffer to the HA partner of the selected nodeInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect device out-of-order delivery informationInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect performance statisticsInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect device port informationInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect device scatter-gather list entry statisticsInputs
Outputs
[Family: cluster]
Iterate over list of nodes in the cluster to get their high-availability interconnect software timeout valuesInputs
Outputs
[Family: vserver]
Adds initiator to an existing initiator group.Inputs
Outputs
[Family: vserver]
Bind an existing igroup to a given portset.Inputs
Outputs
[Family: vserver]
Creates a new initiator group. In Data ONTAP 7.3 and upto ONTAP 8.0, the ALUA (Asymmetric Logical Unit Access) attribute will be enabled by default if initiator-group-type is "fcp" and os-type is "aix", "hpux", or "linux. In Data ONTAP 7-mode 8.1 and later, the ALUA attribute is enabled by default for all os-type if initiator-group-type is "fcp". In Data ONTAP Cluster-Mode 8.1 and later, the ALUA attribute is enabled by default on all initiator groups.Inputs
Outputs
[Family: vserver]
Destroys an existing initiator group. By default a group cannot be destroyed if there are existing lun maps defined for that group. This behaviour can be overridden with the use of force option set to "true" which will destroy the initiator group and any associated lun maps.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of igroup objects.Inputs
Outputs
[Family: vserver]
Find the path to the lun mapped at a given lun-id for a given initiator group.Inputs
Outputs
[Family: cluster]
Displays the supported values and descriptions for initiator-group-os-type.Inputs
Outputs
[Family: vserver]
Removes node(s) from an initiator group. The operation is prohibited if there are existing lun maps defined for that group. The force option set to "true" can be used to forcibly remove the node regardless of mappings.Inputs
Outputs
[Family: vserver]
Rename an existing initiator group. The rename operation is non-disruptive.Inputs
Outputs
[Family: vserver]
Sets an attribute for an initiator group.Inputs
Outputs
[Family: vserver]
Unbind an existing igroup from a portset.Inputs
Outputs
[Family: vserver]
Add one or more Initiator IP Address RangesInputs
Outputs
[Family: vserver]
Generate a 128 bit random password that can be used as a CHAP secret. This API was removed in Data ONTAP 9.0. Applications should use local entropy to generate CHAP secrets if desired.Inputs
Outputs
[Family: vserver]
Remove one or more Initiator IP Address RangesInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Connection objects.Inputs
Outputs
[Family: vserver]
Add initiator to the authentication list.Inputs
An example of a valid IPv4 address range is: '192.168.1.100-192.168.1.150'. An example of a valid IPv6 address range is: '2001:db8::1000:1-2001:db8::1000:50'.
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI initiator authentication configuration objects.Inputs
Outputs
[Family: vserver]
Delete initiator from the authentication listInputs
Outputs
[Family: vserver]
Get the authentication info for an initiator, if auth type is CHAP, only the user-name is returned, password is not returned for security purposes.Inputs
Outputs
An example of a valid IPv4 address range is: '192.168.1.100-192.168.1.150'. An example of a valid IPv6 address range is: '2001:db8::1000:1-2001:db8::1000:50'.
[Family: vserver]
Get the default authentication information for iscsi. If the authentication type is CHAP, only the username is returned, and not the password, for security purposes.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of remote iSCSI initiator objects.Inputs
Outputs
[Family: vserver]
Modify CHAP parameters to an existing per-initiator authentication info whose auth-type equals CHAP.Inputs
Outputs
[Family: vserver]
Configure the default authentication method. If an initiator is not configured with a specific authentication method using iscsi-initiator-add-auth the default authentication method will be applied to it.Inputs
Outputs
[Family: vserver]
Add the iSCSI LIFs to the accesslist of the specified initiatorInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Interface Accesslist objects.Inputs
Outputs
[Family: vserver]
Remove the iSCSI LIFs from the accesslist of the specified initiatorInputs
Outputs
[Family: vserver]
Disables an interface for use by iSCSIInputs
Outputs
[Family: vserver]
Enables an interface for use by iSCSIInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI target interface objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of an iSCSI interface object.Inputs
Outputs
[Family: vserver]
Configures the iSNS service. In Data ONTAP Cluster-Mode, this this API can only modify the configuration of a Vserver where an iSNS service has already been created. To create an iSNS service in a Vserver where one does not exist, use the iscsi-isns-create API.Inputs
Outputs
[Family: vserver]
Create iSNS Service in a Vserver.Inputs
Outputs
[Family: vserver]
Destroy the iSNS Service in a Vserver.Inputs
Outputs
[Family: vserver]
Gets iSNS service configuration.Inputs
Outputs
[Family: cluster, vserver]
Gets iSNS service configuration.Inputs
Outputs
[Family: vserver]
Start iSNS service. The service will be available once the call returns with success.Inputs
Outputs
[Family: vserver]
Stops iSNS service. Service will not be available once the call returns with success.Inputs
Outputs
[Family: vserver]
Forces iSNS service to update server.Inputs
Outputs
[Family: vserver]
Return the current iscsi node name.Inputs
Outputs
[Family: vserver]
Set the current iscsi node name.Inputs
Outputs
[Family: vserver]
Create an iSCSI Service in a Vserver. Each Vserver requires an online iSCSI Service in order to serve data via the iSCSI protocol.Inputs
Outputs
[Family: vserver]
Destroy the iSCSI Service in a Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of iSCSI Services.Inputs
Outputs
[Family: vserver]
Modify an iSCSI Service in a Vserver.Inputs
Outputs
[Family: vserver]
Start iSCSI service. The service will be available once the call returns with success.Inputs
Outputs
[Family: vserver]
Get status of the iSCSI service, whether or not it is running.Inputs
Outputs
[Family: vserver]
Stops iSCSI service. Service will be not be available once the call returns with success.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI session objects.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iscsi objects.Inputs
Outputs
[Family: vserver]
Clear the current iscsi target aliasInputs
Outputs
[Family: vserver]
Return the current iscsi target aliasInputs
Outputs
[Family: vserver]
Set the current iscsi target aliasInputs
Outputs
[Family: vserver]
Create a new user defined target portal group.Inputs
Outputs
[Family: vserver]
Destroy a tpgroup. Only user defined target portal groups may be destroyed.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Target Portal Group objects.Inputs
Outputs
[Family: vserver]
Add an interface to a target portal group. Interfaces may only be added to a user defined target portal group.Inputs
Outputs
[Family: vserver]
Remove an interface from a target portal group. Interfaces may only be removed from a user defined target portal group. Removing an interface will return it to the system defined default group for the interface.Inputs
Outputs
[Family: vserver]
Get a single job entry. This is just a performance optimization for job-get that only searches for the job among the ones currently owned by the given node.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job records organized by node. This is just a performance optimization for job-get-iter that only searches for the job among the ones currently owned by the given node.Inputs
Outputs
[Family: vserver]
Get a single completed job entry. This is just a performance optimization for job-get.Inputs
Outputs
[Family: cluster, vserver]
Get multiple completed job records. This is just a performance optimization for job-get-iter.Inputs
Outputs
[Family: vserver]
Get a single job entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job records.Inputs
Outputs
[Family: vserver]
Get a single job history event.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job history records.Inputs
Outputs
[Family: vserver]
Pause a job. A job must be of a type that has job-type-is-pausible set to true before it may be paused. Once notified of a pause request, a job should stop performing work until it is subsequently resumed.Inputs
Outputs
[Family: cluster, vserver]
Pause a collection of jobs.Inputs
Outputs
[Family: vserver]
Get a single completed, private job entry. This is just a performance optimization for job-private-get.Inputs
Outputs
[Family: cluster, vserver]
Get multiple completed, private job records. This is just a performance optimization for job-private-get-iter.Inputs
Outputs
[Family: vserver]
Get a single private job entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple private job records.Inputs
Outputs
[Family: vserver]
Pause a private job.Inputs
Outputs
[Family: cluster, vserver]
Pause a collection of private jobs.Inputs
Outputs
[Family: vserver]
Resume a job.Inputs
Outputs
[Family: cluster, vserver]
Resume a collection of jobs.Inputs
Outputs
[Family: vserver]
Soft pause a private job.Inputs
Outputs
[Family: cluster, vserver]
Soft pause a collection of private jobs.Inputs
Outputs
[Family: vserver]
Stop a job.Inputs
Outputs
[Family: cluster, vserver]
Stop a collection of jobs.Inputs
Outputs
[Family: cluster]
Get the job queue configurationInputs
Outputs
[Family: cluster]
Modify the job queue configurationInputs
Outputs
[Family: vserver]
Resume a job from the paused state.Inputs
Outputs
[Family: cluster, vserver]
Resume a collection of jobs.Inputs
Outputs
[Family: cluster, vserver]
Create a new cron job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Delete a single cron job schedule entry. The entry must not be in use.Inputs
Outputs
[Family: cluster, vserver]
Delete multiple cron job schedule entries. The entries must not be in use.Inputs
Outputs
[Family: cluster, vserver]
Get a single cron job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple cron job schedule entries.Inputs
Outputs
[Family: cluster, vserver]
Modify an existing cron job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get a single job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job schedule entries.Inputs
Outputs
[Family: cluster, vserver]
Create a new interval job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Delete a single interval job schedule entry. The entry must not be in use.Inputs
Outputs
[Family: cluster, vserver]
Delete multiple interval job schedule entries. The entries must not be in use.Inputs
Outputs
[Family: cluster, vserver]
Get a single interval job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple interval job schedule entries.Inputs
Outputs
[Family: cluster, vserver]
Modify an existing interval job schedule entry.Inputs
Outputs
[Family: vserver]
Soft pause a job. Indicates to the job that a soft pause has been initiated. It is up to the job to do what it needs to do for a soft pause. As a result of this command the job may request to be moved into the runnnable queue to perform further processing of the soft pause.Inputs
Outputs
[Family: cluster, vserver]
Soft pause a collection of jobs.Inputs
Outputs
[Family: vserver]
Stop a job. A job must be of a type that has job-type-is-quittable set to true before it may be stopped. job-stop attempts to stop a job that's currently running. If the job allows itself to stop it completes its current run. If the job has a recurring schedule it will transition to the Queued state; otherwise it will transition into either the Success or Failure state.Inputs
Outputs
[Family: cluster, vserver]
Stop a collection of jobs.Inputs
Outputs
[Family: vserver]
Get Kerberos configuration information for a LIF.Inputs
Outputs
[Family: cluster, vserver]
Get Kerberos configuration information for a group of LIFs.Inputs
Outputs
[Family: vserver]
Modify Kerberos configuration information for a LIFInputs
Outputs
[Family: vserver]
Create a new Kerberos realm configuration.In Data ONTAP 8.2.x and prior versions, Kerberos realms were owned by Cserver and were accessible only from Admin Vserver LIFs using the input 'config-name'. The 'vserver' input was not required.
Starting from Data ONTAP 8.3.0, Kerberos realms are owned by data Vservers and are accessible from both Admin and data Vserver LIFs. The 'config-name' input can no longer be used as a key. The 'realm' input must be used instead. The 'vserver' input is required.
Inputs
Outputs
[Family: vserver]
Delete the Kerberos realm configuration.In Data ONTAP 8.2.x and prior versions, Kerberos realms were owned by Cserver and were accessible only from Admin Vserver LIFs using the input 'config-name'. The 'vserver' input was not required.
Starting from Data ONTAP 8.3.0, Kerberos realms are owned by data Vservers and are accessible from both Admin and data Vserver LIFs. The 'config-name' input can no longer be used as a key. The 'realm' input must be used instead. The 'vserver' input is required.
Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Kerberos realm configurations.Inputs
Outputs
[Family: vserver]
Modify the Kerberos realm configuration.In Data ONTAP 8.2.x and prior versions, Kerberos realms were owned by Cserver and were accessible only from Admin Vserver LIFs using the input 'config-name'. The 'vserver' input was not required.
Starting from Data ONTAP 8.3.0, Kerberos realms are owned by data Vservers and are accessible from both Admin and data Vserver LIFs. The 'config-name' input can no longer be used as a key. The 'realm' input must be used instead. The 'vserver' input is required.
Inputs
Outputs
[Family: cluster, vserver]
Display the status of an LDAP configurationInputs
Outputs
[Family: vserver]
Create a new Lightweight Directory Access Protocol (LDAP) client configuration for the cluster.Inputs
Outputs
[Family: vserver]
Delete an existing Lightweight Directory Access Protocol (LDAP) client configuration from the cluster.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) client configurations for the cluster.Inputs
Outputs
[Family: vserver]
Modify an existing Lightweight Directory Access Protocol (LDAP) client configuration.Inputs
Outputs
[Family: vserver]
Copy an existing LDAP schema. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, this API can be used to create an editable copy of an existing read-only schema. After copying the schema, the copy can be modified using the ldap-client-schema-modify API.Inputs
Outputs
[Family: vserver]
Delete an existing Lightweight Directory Access Protocol (LDAP) schema configuration. Only the schemas that are defined using the ldap-client-schema-copy API can be deleted using this API.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) client schema configurations that are defined for the cluster.Inputs
Outputs
[Family: vserver]
Modify an existing Lightweight Directory Access Protocol (LDAP) schema configuration. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, the ldap-client-schema-copy API can be used to create a editable copy of an existing read-only schema. After copying the schema, the copy can be modified using this API to support the target schema.Inputs
Outputs
[Family: vserver]
Create a new association between a Lightweight Directory Access Protocol (LDAP) client configuration and a Vserver. A Vserver can have only one client configuration associated with it.Inputs
Outputs
[Family: vserver]
Delete a Vserver's association with a Lightweight Directory Access Protocol (LDAP) configuration.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) configurations in the cluster.Inputs
Outputs
[Family: vserver]
Modify the Lightweight Directory Access Protocol (LDAP) configuration for a Vserver.Inputs
Outputs
[Family: cluster]
Add license for a Data ONTAP service.Inputs
Outputs
[Family: cluster]
Add entitlements described in license contentInputs
Outputs
[Family: cluster]
Adds V2 capacity license.Inputs
Outputs
[Family: cluster]
Get V2 capacity license information. This command is deprecated in Data ONTAP 9.2 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Returns capacity pool usage information for each cluster aggregate.Inputs
Outputs
[Family: cluster]
Returns licenses that can be cleaned up. A license can be cleaned up if it's a demo license and its expiration time has passed (expired), or if it is a license for a controller that is no longer part of a cluster (unused). One can use the cleanup apis to remove these licenses together, or alternatively, they can use the standard license-remove api to remove them one at a time.Inputs
Outputs
[Family: cluster]
Removes license for a Data ONTAP service.Inputs
Outputs
[Family: cluster]
Remove licenses that have expired in the cluster.Inputs
Outputs
[Family: cluster]
Remove licenses that have no controller affiliation in the cluster.Inputs
Outputs
[Family: cluster]
Returns license entitlement risk for cluster mode packages.Inputs
Outputs
[Family: cluster]
Attempt to reconcile capacity leasesInputs
Outputs
[Family: cluster]
Get license manager configurationInputs
Outputs
[Family: cluster]
Modify license manager configurationInputs
Outputs
[Family: cluster]
Check accessibility of license managerInputs
Outputs
[Family: cluster]
Returns infomation for DATA ONTAP licenses.Inputs
Outputs
[Family: cluster]
Get Data ONTAP licenses status information.Inputs
Outputs
[Family: cluster]
Returns license status information for cluster mode packages. This command is deprecated in Data ONTAP 9.2 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Add V2 subscription license.Inputs
Outputs
[Family: cluster]
Get V2 subscription license information.Inputs
Outputs
[Family: cluster]
Get Data ONTAP aggregate license information.Inputs
Outputs
[Family: cluster, vserver]
Breaks one or more locks in the cluster that match the query.Inputs
Outputs
[Family: cluster, vserver]
Returns information for one or more locks in the cluster that match the query.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
Outputs
[Family: vserver]
Reset LUN Alignment StatisticsInputs
Outputs
[Family: vserver]
Clear the SCSI-2 reservation or SCSI-3 persistent reservation information for a given LUN. Note: In Data ONTAP Cluster-Mode, the LUN must either be offline or not mapped to clear the persistent reservation information.Inputs
Outputs
[Family: cluster, vserver]
Cancels an ongoing LUN copy operation prior to creation of the new LUN. This operation will fail if the LUN already exists at the destination path; in that case, use the lun-destroy API to delete the LUN at the destination path.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of LUN copy job detail objects.Inputs
Outputs
[Family: cluster, vserver]
Modifies the maximum throughput of an ongoing copy operation.Inputs
Outputs
[Family: cluster, vserver]
Pauses an ongoing LUN copy operation. Use the lun-copy-resume API to resume the copy operation.Inputs
Outputs
[Family: cluster, vserver]
Resumes a paused LUN copy operation.Inputs
Outputs
[Family: cluster, vserver]
Starts copying a group of LUNs from one volume to another. The destination volume can be located on the same Vserver as the original volume or on a different Vserver. If source-vserver is not specified, the source Vserver defaults to the target Vserver, i.e., an intra-Vserver copy. Intra-Vserver copy can be initiated by both cluster and Vserver administrators. Inter-Vserver copy can be initiated by cluster administrators only. Note: A cluster administrator must first create a Vserver peer relationship using vserver-peer-create API before a Vserver administrator can copy over LUNs from another Vserver in the cluster. This restriction does not apply to cluster administrators. Cluster administrators can initiate inter-Vserver LUN copy operations without creating a Vserver peer relationship.Inputs
Outputs
[Family: vserver]
Create a new lun of given size, with initially zero contents. The lun is created at the path given. No file should already exist at the given path. The directory specified in the path must be a qtree root directory. The size of the created lun could be larger than the size specified, in order to get an integral number of cylinders while reporting the geometry using SAN protocols.Inputs
Outputs
[Family: vserver]
Create a lun from an existing file. A new lun is created, at the given lun path (which must be at a qtree root). A hard link is created to the existing file. The file contents are not copied or changed. The file can be resized to a larger size, rounding up to a cylinder boundary. NOTE: LUNs created from files cannot be relocated.Inputs
Outputs
[Family: vserver]
Destroy the specified LUN. This operation will fail if the LUN is currently mapped and is online. The force option can be used to destroy it regardless of being online or mapped.Inputs
Outputs
[Family: cluster, vserver]
Generate a LUN Serial Number for later use.Inputs
Outputs
[Family: vserver]
Get a named attribute for a given LUN.Inputs
Outputs
[Family: vserver]
Get named attributes for a given LUN.Inputs
Outputs
[Family: vserver]
Get the optional descriptive comment for a LUN.Inputs
Outputs
[Family: vserver]
Get SCSI disk geometry for a given LUN.Inputs
Outputs
[Family: vserver]
Get the SCSI INQUIRY response data for vendor id (vid), product id (pid), and firmware revision (rev) based on the igroup that the lun in question is mapped to.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
Outputs
[Family: vserver]
Returns the maximum possible size in bytes of a lun on a given volume or qtree. The user can pass the path to a volume or qtree in which the lun is to be created. This returns the maximum size for different types of LUNs and the possible maximum size with or without snapshot reserves.Inputs
Outputs
[Family: vserver]
Returns the minimum possible size in bytes. This returns the minimum size for different types of LUNs (based on the specified OS type). Space reservation does not affect the minimum lun size, thus only a single minimum size is returned.Inputs
Outputs
[Family: vserver]
Get the size occupied by the LUN in the active FS.Inputs
Outputs
[Family: vserver]
Get the persistent reservation information for a given LUN.Inputs
Outputs
[Family: vserver]
Get the select attribute for the specified LUN.Inputs
Outputs
[Family: vserver]
Get the serial number for the specified LUN. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .Inputs
Outputs
[Family: vserver]
Queries the space reservation settings for the named LUN.Inputs
Outputs
[Family: cluster, vserver]
Lookup a LUN path and storage system by serial number.Inputs
Outputs
[Family: vserver]
Queries for all types of scsi reservations covering both iSCSI and FCP.Inputs
Outputs
[Family: cluster]
Create a LUN import relationship with the purpose of importing foreign disk data into the LUN.Inputs
Outputs
[Family: cluster]
Deletes the import relationship of the specified LUN or the specified foreign disk.Inputs
Outputs
[Family: cluster]
Iterate over a list of LUN objects that are in a relationship with a foreign disk.Inputs
Outputs
[Family: cluster]
Pause the import for the specified LUN.Inputs
Outputs
[Family: cluster]
Resume the import for the specified LUN.Inputs
Outputs
[Family: cluster]
Start the import for the specified LUN.Inputs
Outputs
[Family: cluster]
Stop and abort the import for the specified LUN. All import checkpoint data will be lost.Inputs
Outputs
[Family: cluster]
Modify the max throughput limit for the specified import relationshipInputs
Outputs
[Family: cluster]
Start the verification of the foreign disk and LUN data. The import admin/operational state must be stopped/stopped or started/completed. The verification does a block for block comparison of the LUN and foreign disk. If the verification detects a mismatch between the foreign disk and LUN then the verify will stop.Inputs
Outputs
[Family: cluster]
Stop the verify for the specified LUN.Inputs
Outputs
[Family: cluster, vserver]
List all the LUNs mapped to an initiatorInputs
Outputs
[Family: vserver]
Determine if an initiator is logged in via FCP or iSCSI.Inputs
Outputs
[Family: vserver]
Maps the LUN to all the initiators in the specified initiator group.Inputs
Outputs
[Family: vserver]
Add nodes to the list reporting the LUN map. If no specific action is provided, adds all the nodes in the current failover group for the LUN.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of LUN map detail objects.Inputs
Outputs
[Family: vserver]
Returns a list of initiator groups and their members (the initiators) mapped to the given LUN.Inputs
Outputs
[Family: vserver]
Remove nodes from the list reporting the LUN map. If no specific action is provided, remove all nodes not in the current failover group for the LUN.Inputs
Outputs
[Family: vserver]
Move (rename) a LUN.Inputs
Outputs
[Family: vserver]
Cancels an ongoing LUN move operation prior to creation of the new LUN. This operation will fail if the LUN already exists at the destination path; in that case, allow the current move operation to complete and then move it back using the lun-move-start API.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of LUN move job detail objects.Inputs
Outputs
[Family: vserver]
Modifies the maximum throughput of an ongoing move operation.Inputs
Outputs
[Family: vserver]
Pauses an ongoing LUN move operation. Use the lun-move-resume API to resume the move operation.Inputs
Outputs
[Family: vserver]
Resumes a paused LUN move operation.Inputs
Outputs
[Family: vserver]
Starts a LUN move operation to move one or more LUNs from one volume to another within a Vserver. The destination volume can be located on the same node as the source volume or on a different node. NOTE: LUNs created from files cannot be moved.Inputs
Outputs
[Family: vserver]
Disables block-protocol accesses to the LUN. Mappings, if any, configured for the lun are not altered. Note that unless explicitly offlined, a lun is online.Inputs
Outputs
[Family: vserver]
Re-enables block-protocol accesses to the lun.Inputs
Outputs
[Family: cluster]
Displays the supported values and descriptions for lun-os-type.Inputs
Outputs
[Family: vserver]
Queries for all types of scsi reservations covering both iSCSI and FCP for a given initiator name. Initiator name can be FCP portname in case of FCP or iSCSI node name for iSCSI.Inputs
Outputs
[Family: vserver]
Changes the size of the LUN. Note that client-side operations may be needed to ensure that client software recognizes the changed size. For Data ONTAP Cluster-Mode 8.3 and later, LUN resize is not allowed while the LUN is in import relationship with a Foreign LUN.Inputs
Outputs
[Family: vserver]
Set a named attribute for a given LUN. Attributes are arbitrary key/value pairs for application-defined use.Inputs
Outputs
[Family: vserver]
Set the optional descriptive comment for a LUN.Inputs
Outputs
[Family: vserver]
Set a SCSI peripheral device identifying information value on a LUN. In Data ONTAP 7-Mode, the value set will be returned in response to the vendor unique SCSI command GET DEV ID. In Data ONTAP Cluster-Mode, the value set will be returned in response to the SCSI command REPORT IDENTIFYING INFORMATION for the appropriate INFORMATION TYPE:Inputs
Outputs
[Family: vserver]
nullInputs
Outputs
[Family: vserver]
Set the select attribute for the specified LUN. The select attribute is used by multi-pathing software to discriminate between LUNs when mirrored or cloned copies of a vdisk are mapped to the same host.Inputs
Outputs
[Family: vserver]
Set the serial number for the specified LUN. The lun must first be made offline before changing the serial number. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .Inputs
Outputs
[Family: vserver]
Modify the attributes of lun object.Inputs
Outputs
[Family: vserver]
Sets the space reservation settings for the named LUN.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
Outputs
[Family: vserver]
Reverses the effect of lun-map on the specified LUN for the specified group. For Data ONTAP Cluster-Mode 8.3 and later, if LUN is in import relationship, the last LUN map can not be deleted.Inputs
Outputs
[Family: vserver]
Clear a named attribute for a given LUN.Inputs
Outputs
[Family: vserver]
Remove a SCSI peripheral device identifying information value from a LUN.Inputs
Outputs
[Family: cluster]
This API returns information regarding the eligibility of aggregates to host configuration replication volumes used for the replication of metrocluster configuration data.Inputs
Outputs
[Family: cluster]
This API returns information regarding the eligibility of aggregates to host configuration replication volumes used for the replication of metrocluster configuration data.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-check-aggregate-info objectsInputs
Outputs
[Family: cluster]
This API returns information regarding the capture status of replicated metrocluster configuration data.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-check-cluster-info objectsInputs
Outputs
[Family: cluster]
Obtain the results of the MetroCluster config replication checks.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-check-info objects.Inputs
Outputs
[Family: cluster]
The MetroCluster-check-lif-repair-placement API verifies LIF placement in the destination cluster for the sync-source Vserver LIF in a MetroCluster setup.Inputs
Outputs
[Family: cluster]
The MetroCluster-check-lif-update-vserver-name API updates the Vserver name for failed LIF placement entries for Vserver LIFs after the Vserver has been renamed in a MetroCluster setup.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-check-node-info objectsInputs
Outputs
[Family: cluster]
The metrocluster-check-run API starts a check on the metrocluster configuration. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-check-volume objectsInputs
Outputs
[Family: cluster]
Provides the differences in attributes of a specified configuration instance between two clusters in DR relationship for MetroCluster. This helps in verifying if the configuration of interest is replicated correctly from source cluster to destination cluster. If the source configuration matches that of destination, EOBJECTNOTFOUND is returned, indicating that the difference is nil. This API can be invoked on the source cluster or destination cluster. Note: The configuration objects replicated as part of MetroCluster and their keys can potentially change from release to release. If a program has opted to use those as inputs for selection, it may have to be adjusted for updated versions of Data ONTAP.Inputs
Outputs
[Family: cluster]
Provides the differences in configuration between two clusters in DR relationship for MetroCluster. If an object is not specified, the differences for all replicated objects are shown. If the source configuration matches that of destination, EOBJECTNOTFOUND is returned, indicating that the difference is nil. This API can be invoked on the source cluster or destination cluster. Note: The configuration objects replicated as part of MetroCluster and their keys can potentially change from release to release. If a program has opted to use those as inputs for selection, it may have to be adjusted for updated versions of Data ONTAP.Inputs
Outputs
[Family: cluster]
The metrocluster-config-replication-cluster-storage-configuration-get API returns information regarding the configuration of the cluster-wide storage associated with cross-cluster replication of metrocluster configuration data.On Data ONTAP 8.3, metrocluster cannot be enabled simultaneously with Async Vserver DR. For this reason this command will return an error if Async Vserver DR is currently enabled on the cluster.
Inputs
Outputs
[Family: cluster]
The metrocluster-config-replication-cluster-storage-configuration-modify API modifies nformation regarding the configuration of the cluster-wide storage associated with cross-cluster replication of metrocluster configuration data.If input is not provided for a particular value, then the item is not modified in the storage configuration.
On Data ONTAP 8.3, metrocluster cannot be enabled simultaneously with Async Vserver DR. For this reason this command will return an error if Async Vserver DR is currently enabled on the cluster.
Inputs
Outputs
[Family: cluster]
Get MetroCluster configuration replication synchronization informationInputs
Outputs
[Family: cluster]
The metrocluster-configure API configures a node and its DR partner to mirror NVRAM and be configured to participate in a DR switchover. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The create-periodic-job API creates the periodic check job.Inputs
Outputs
[Family: cluster]
The delete-periodic-job API deletes the periodic check job.Inputs
Outputs
[Family: cluster]
The metrocluster-disable-periodic-check API disables periodic check on the metrocluster configuration.Inputs
Outputs
[Family: cluster]
The enable-periodic-check API enables periodic check on the metrocluster configuration.Inputs
Outputs
[Family: cluster]
Get MetroCluster configuration informationInputs
Outputs
[Family: cluster]
The metrocluster-heal API heals aggregates and partner roots in preparation for a DR switchback. Healing of aggregates and partner roots is done in two phases by the admin. DR partner nodes must be powered off and remote disk shelves must be powered on before calling this API. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-interconnect-adapter objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-interconnect-ipfo objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-interconnect-mirror objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-interconnect-mirror-multipath objects.Inputs
Outputs
[Family: cluster]
Get MetroCluster Interconnect Remote Cluster ReachableInputs
Outputs
[Family: cluster]
The metrocluster-is-configured API returns a value indicating if the cluster is configured for MetroCluster.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-node-info objects belonging to MetroCluster nodesInputs
Outputs
[Family: cluster]
Iterate over a list of MetroCluster operations and their detailsInputs
Outputs
[Family: cluster]
Iterate over a list of Metrocluster operation statistics.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-progress-table-info objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of LIF placement failures in a MetroCluster setup.Inputs
Outputs
[Family: cluster]
The metrocluster-switchback API initiates the switchback of storage and client access from nodes in the DR site to their home nodes. The home nodes and storage shelves must be powered on and reachable by nodes in the DR site. The metrocluster heal-aggregates and metrocluster heal-roots APIs must have successfully completed before running the metrocluster-switchback API. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The metrocluster-switchover API initiates the switchover of storage and client access from a disaster stricken site to the DR site. Nodes in the disaster stricken site must be powered off and unreachable by nodes in the DR site before initiating the switchover operation. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The metrocluster-unconfigure API wipes the configuration from nodes in a DR group which are in the local cluster where the API is issued. This includes all the nodes in the specified DR group in that local cluster. Nodes in the DR group are disallowed from participating in the metrocluster switchover after the configuration has been wiped. This API is used to tear down a metrocluster setup. The tear down of a node is completed when the hardware that activates the node for metrocluster, such as an FC-VI adapter, is removed or deactivated. A job will be spawned to operate on the metrocluster and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster objects.Inputs
Outputs
[Family: cluster]
Resynchronize Vserver with its partner VserverInputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-check-connection-info objectsInputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-configuration-settings-info objectsInputs
Outputs
[Family: cluster]
Configure the connections that mirror the NV logs and access remote storage between partner nodes in MetroCluster sertup A job will be spawned to operate on the metrocluster-connection and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Tear down the connections that mirror the NV logs and access remote storage between partner nodes in MetroCluster setup A job will be spawned to operate on the metrocluster-connection and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-connection-info objectsInputs
Outputs
[Family: cluster]
Create MetroCluster DR groupInputs
Outputs
[Family: cluster]
Delete MetroCluster DR groupInputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-dr-group-info objectsInputs
Outputs
[Family: cluster]
Create a MetroCluster InterfaceInputs
Outputs
[Family: cluster]
Delete a MetroCluster InterfaceInputs
Outputs
[Family: cluster]
Iterate over a list of metrocluster-interface-info objectsInputs
Outputs
[Family: vserver]
Create a new name mapping for a Vserver.Inputs
Outputs
[Family: vserver]
Delete an existing name mapping entry.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of name mappings in the cluster.Inputs
Outputs
[Family: vserver]
Insert a name mapping into the table at a specified position.Inputs
Outputs
[Family: vserver]
Modify an existing name mapping entry.Inputs
Outputs
[Family: vserver]
Resolve The IP addresses for the configured Hostname.Inputs
Outputs
[Family: vserver]
Swap the position of one name mapping with another. The position is the place in the sequence of name mappings in which the mappings are applied.Inputs
Outputs
[Family: vserver]
Add a user to a UNIX groupInputs
Outputs
[Family: vserver]
Create a new UNIX group.Inputs
Outputs
[Family: vserver]
Delete a user from a UNIX groupInputs
Outputs
[Family: vserver]
Destroy an existing UNIX group.Inputs
Outputs
[Family: vserver]
Get the attributes of a UNIX group.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of UNIX groups.Inputs
Outputs
[Family: vserver]
Modify the attributes of a UNIX group.Inputs
Outputs
[Family: vserver]
Create a new UNIX user.Inputs
Outputs
[Family: vserver]
Destroy an existing UNIX user.Inputs
Outputs
[Family: vserver]
Get the attributes of a UNIX user.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of UNIX users.Inputs
Outputs
[Family: vserver]
Modify the attributes of a UNIX user.Inputs
Outputs
[Family: vserver]
Get the name services group membership cache configuration of the VserverInputs
Outputs
[Family: vserver]
Modify the name services group membership cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: vserver]
Get the name services hosts cache configuration of the VserverInputs
Outputs
[Family: vserver]
Modify the name services hosts cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: vserver]
Get the name services netgroup cache configuration of the VserverInputs
Outputs
[Family: vserver]
Modify the name services netgroup cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: vserver]
Get the name services UNIX group cache configuration of the VserverInputs
Outputs
[Family: vserver]
Modify the name services UNIX group cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: vserver]
Get the name services UNIX users cache configuration of the VserverInputs
Outputs
[Family: vserver]
Modify the name services UNIX users cache configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster, vserver]
Retrieve DNS statistics of the cluster.Inputs
Outputs
[Family: vserver]
Show bound NIS serversInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of bound NIS serversInputs
Outputs
[Family: vserver]
Show bound nis serversInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of bound nis serversInputs
Outputs
[Family: cluster, vserver]
Retrieve NIS statistics of the cluster.Inputs
Outputs
[Family: vserver]
Display Configuration for UNIX-Group file downloadInputs
Outputs
[Family: vserver]
Display Configuration for UNIX-User file downloadInputs
Outputs
[Family: cluster, vserver]
Clear DNS statistics.Inputs
Outputs
[Family: cluster]
Get the host information from the IP address.Inputs
Outputs
[Family: cluster]
Get the IP address information by using the host name.Inputs
Outputs
[Family: cluster]
Get the IP address information from host name.Inputs
Outputs
[Family: cluster, vserver]
Clear NIS statistics.Inputs
Outputs
[Family: vserver]
Create an Name Service Switch Configuration.Inputs
Outputs
[Family: vserver]
Destroy an existing Name Service Switch Configuration.Inputs
Outputs
[Family: vserver]
Get Name Service Switch Configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of Name Service Switch Configurations.Inputs
Outputs
[Family: vserver]
Modify the attributes of Name Service Switch Configuration.Inputs
Outputs
[Family: cluster]
Iterate over a list of ndmp objects.Inputs
Outputs
[Family: cluster]
Kill a NDMP session on a nodeInputs
Outputs
[Family: cluster]
Kill all NDMP sessions on a nodeInputs
Outputs
[Family: vserver]
Generate NDMP password for the given user in a specific Vserver context. The generated NDMP password is based on the actual login password for the user; hence it should be regenerated whenever the actual user password is changed.Inputs
Outputs
[Family: cluster, vserver]
Get NDMP attributes for vserver.Inputs
Outputs
[Family: vserver]
Modify NDMP attributes for vserver.Inputs
Outputs
[Family: vserver]
Disable NDMP service on the vserver. Disabling ndmp service on the vserver will not cause any disruption to NDMP operations that are running. Executing this zapi when the ndmp service is already disabled will not result in any errors.Inputs
Outputs
[Family: vserver]
Enable NDMP service on the vserver. Enabling ndmp service on the vserver will not cause any disruption to NDMP operations that are running. Executing this zapi when the ndmp service is already enabled will not result in any errors.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of ndmp objects.Inputs
Outputs
[Family: vserver]
Kill a NDMP session on a vserverInputs
Outputs
[Family: vserver]
Kill all NDMP sessions on a vserverInputs
Outputs
[Family: cluster]
Get the IP data LIF capacity of the cluster.Inputs
Outputs
[Family: cluster]
Get the IP data LIF capacity details for each node.Inputs
Outputs
[Family: vserver]
Get the attributes of the network route active-entry.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network route active-entry objects.Inputs
Outputs
[Family: cluster]
Delete dynamically learned ARP entries.Inputs
Outputs
[Family: cluster]
Get the attributes of the network ARP active entry which is present in network stack of the node.Inputs
Outputs
[Family: cluster]
Iterate over a list of network ARP active entries.Inputs
Outputs
[Family: cluster, vserver]
Create a new network ARP entry.Inputs
Outputs
[Family: cluster, vserver]
Delete an existing network ARP entry.Inputs
Outputs
[Family: cluster, vserver]
Get the attributes of the network ARP entry which is present in Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network ARP entries.Inputs
Outputs
[Family: cluster]
Create the BGP configuration for a given node.Inputs
Outputs
[Family: cluster]
Delete the BGP configuration on a given node.Inputs
Outputs
[Family: cluster]
Get the BGP configuration for a node.Inputs
Outputs
[Family: cluster]
Iterate over the BGP configuration for each node.Inputs
Outputs
[Family: cluster]
Modify BGP configuration for a given node.Inputs
Outputs
[Family: cluster]
Get the cluster wide default BGP configuration.Inputs
Outputs
[Family: cluster]
Modify the cluster wide default BGP configuration.Inputs
Outputs
[Family: cluster]
Create a new BGP peer group.Inputs
Outputs
[Family: cluster]
Destroy an existing BGP peer group.Inputs
Outputs
[Family: cluster]
Get the attributes of the peer group.Inputs
Outputs
[Family: cluster]
Iterate over a list of BGP peer groupsInputs
Outputs
[Family: cluster]
Modify the attributes of the BGP peer group.Inputs
Outputs
[Family: cluster]
Rename a BGP peer group.Inputs
Outputs
[Family: cluster]
Get BGP status of a Vserver on a given node.Inputs
Outputs
[Family: cluster]
Iterate over BGP Vservers status.Inputs
Outputs
[Family: cluster]
Get the list of LIFs at risk.Inputs
Outputs
[Family: cluster, vserver]
Ping an IP address to verify whether the interface is aliveInputs
Outputs
[Family: cluster, vserver]
Ping an IPv6 address to verify whether the interface is aliveInputs
Outputs
[Family: cluster]
Get the receive buffer size properties of a serviceInputs
Outputs
[Family: cluster]
Iterate over connections returning receive buffer size propertiesInputs
Outputs
[Family: cluster]
Modify receive buffer size propertiesInputs
Outputs
[Family: vserver]
Get the Dynamic DNS Update configuration of the VserverInputs
Outputs
[Family: cluster, vserver]
Iterate through Dynamic DNS Update configurations of the clusterInputs
Outputs
[Family: vserver]
Modify the Dynamic DNS Update configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Iterate over a list of network device discovery objects found by a discovery protocol such as CDP or LLDP.Inputs
Outputs
[Family: cluster, vserver]
Display the status of a list of name serversInputs
Outputs
[Family: vserver]
Creates DNS configuration for a VserverInputs
Outputs
[Family: vserver]
Get the DNS configuration of the VserverInputs
Outputs
[Family: cluster, vserver]
Iterate through DNS configurations of the clusterInputs
Outputs
[Family: vserver]
Modify the DNS configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Create a new external routing tableInputs
Outputs
[Family: cluster]
Delete an existing external routing tableInputs
Outputs
[Family: cluster]
Add failover targets to a failover group.Inputs
Outputs
[Family: cluster]
Create a failover group. Failover groups are used to define a set of possible failover targets for LIFs on one or more nodes.Inputs
Outputs
[Family: cluster]
Delete a failover groupInputs
Outputs
[Family: vserver]
Get the attributes of a failover goup.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of failover group objects.Inputs
Outputs
[Family: cluster]
Modify a failover group.Inputs
Outputs
[Family: cluster]
Remove failover targets from a failover group.Inputs
Outputs
[Family: cluster]
Rename a failover group.Inputs
Outputs
[Family: cluster]
Get the attributes of a firewall configuration.Inputs
Outputs
[Family: cluster]
Iterate over a list of firewall configuration objects.Inputs
Outputs
[Family: cluster]
Create a new firewall configuration.Inputs
Outputs
[Family: cluster]
Modify the attributes of a firewall configuration or a group of firewall configuration objects.Inputs
Outputs
[Family: cluster]
Create a new firewall policyInputs
Outputs
[Family: cluster]
Destroy an existing firewall policyInputs
Outputs
[Family: vserver]
Get the attributes of a firewall policy.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of firewall policy objects.Inputs
Outputs
[Family: cluster]
Modify an existing firewall policy.Inputs
Outputs
[Family: vserver]
Create a new IP to host names mappingInputs
Outputs
[Family: vserver]
Delete an existing hosts object.Inputs
Outputs
[Family: vserver]
Given an IP address, return the corresponding IP to host names mapping of the running Vserver contextInputs
Outputs
[Family: cluster, vserver]
Iterate all IP to host name mappings (over all Vserver) of the clusterInputs
Outputs
[Family: vserver]
Given an IP address, modify the corresponding IP to host name mapping. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Create a new logical interface.Inputs
Outputs
[Family: cluster]
Destroy an existing network interface object.Inputs
Outputs
[Family: vserver]
Get the attributes of a network interface.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network interface objects.Inputs
Outputs
[Family: cluster]
Migrate a Logical Interface between nodes and portsInputs
Outputs
[Family: cluster]
Modify the attributes of network interface object.Inputs
Outputs
[Family: cluster]
Modify the attributes of network interface or a group of network interface objects.Inputs
Outputs
[Family: cluster]
Revert a logical interface back to its home port following a deliberate migration or failover.Inputs
Outputs
[Family: cluster]
Get the attributes of the network interface service object.Inputs
Outputs
[Family: cluster]
Iterate over a list of network interface service objects.Inputs
Outputs
[Family: cluster]
Add an additional service to an existing network interface service policy.Inputs
Outputs
[Family: cluster]
Clone a network service policy.Inputs
Outputs
[Family: cluster]
Create a new network interface service policy.Inputs
Outputs
[Family: cluster]
Delete an existing network interface service policy.Inputs
Outputs
[Family: vserver]
Get the attributes of the network interface service policy entry.Inputs
Outputs
[Family: cluster]
Iterate over a list of network interface service policy entry.Inputs
Outputs
[Family: vserver]
Get the attributes of the network interface service policy object.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network interface service policy objects.Inputs
Outputs
[Family: cluster]
Modify the attributes of an existing network interface service policy.Inputs
Outputs
[Family: cluster]
Remove a service from an existing network interface service policy.Inputs
Outputs
[Family: cluster]
Rename a network service policy.Inputs
Outputs
[Family: cluster]
Restore default settings to a network service policy.Inputs
Outputs
[Family: cluster]
Create an IPspaceInputs
Outputs
[Family: cluster]
Delete an IPspaceInputs
Outputs
[Family: cluster]
Get the attributes of an IPspace.Inputs
Outputs
[Family: cluster]
Iterate over a list of IPspace objects.Inputs
Outputs
[Family: cluster]
Rename an IPspace.Inputs
Outputs
[Family: cluster]
Delete an existing network ndp active neighbor object.Inputs
Outputs
[Family: cluster]
Get the attributes of the network ndp active neighbor.Inputs
Outputs
[Family: cluster]
Iterate over a list of network ndp active neighbor objects.Inputs
Outputs
[Family: cluster]
Delete default routers on a given IPspaceInputs
Outputs
[Family: cluster]
Get the attributes of the network ndp default-router.Inputs
Outputs
[Family: cluster]
Iterate over a list of network ndp default-router objects.Inputs
Outputs
[Family: vserver]
Configure a new NDP neighbor entryInputs
Outputs
[Family: vserver]
Delete an existing static NDP neighbor entryInputs
Outputs
[Family: vserver]
Get a static configured NDP neighbor entry.Inputs
Outputs
[Family: cluster, vserver]
Iterator over a list of static configured NDP neighbor entries.Inputs
Outputs
[Family: cluster]
Delete IPv6 prefixes on a given IPspaceInputs
Outputs
[Family: cluster]
Get the attributes of the network ndp prefix.Inputs
Outputs
[Family: cluster]
Iterate over a list of network ndp prefix objects.Inputs
Outputs
[Family: cluster]
Get the attributes of the net.Inputs
Outputs
[Family: cluster]
Get the hypervisor uplink monitoring status.Inputs
Outputs
[Family: cluster]
Modify the hypervisor uplink monitoring status.Inputs
Outputs
[Family: cluster]
Modify the attributes of net object.Inputs
Outputs
[Family: cluster]
Delete LIF placement cached information.Inputs
Outputs
[Family: cluster]
Iterate over the LIF placement cached information.Inputs
Outputs
[Family: cluster]
Find the ports direcly connected to the IP addressInputs
Outputs
[Family: cluster]
Add ports to a layer 2 broadcast domain.Inputs
Outputs
[Family: cluster]
Create a new layer 2 broadcast domain object.Inputs
Outputs
[Family: cluster]
Destroy an existing layer 2 broadcast domain object.Inputs
Outputs
[Family: cluster]
Get the attributes of the layer 2 broadcast domain object.Inputs
Outputs
[Family: cluster]
Iterate over a list of layer 2 broadcast domain objects.Inputs
Outputs
[Family: cluster]
Merges two layer 2 broadcast domains.Inputs
Outputs
[Family: cluster]
Modify the attributes of the layer 2 broadcast domain object.Inputs
Outputs
[Family: cluster]
Remove ports from a layer 2 broadcast domain.Inputs
Outputs
[Family: cluster]
Rename a layer 2 broadcast domain.Inputs
Outputs
[Family: cluster]
Splits a layer 2 broadcast domain into two layer 2 broadcast domains.Inputs
Outputs
[Family: cluster]
Delete a physical network port. This is typically used when there is an entry in the port table reffering to a physical port that was previously removed from a node. Any LIFs hosted on the port must be deleted or moved to another port before deletion of the port is permittedInputs
Outputs
[Family: cluster, vserver]
Get the attributes of a network port.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network port objects.Inputs
Outputs
[Family: cluster]
Disable one or more port health monitorsInputs
Outputs
[Family: cluster]
Enable one or more port health monitorsInputs
Outputs
[Family: cluster]
Get the network port health monitors enabled for an IPspace.Inputs
Outputs
[Family: cluster]
Iterate over the the network port health monitors enabled for each IPspace.Inputs
Outputs
[Family: cluster]
Add port to a network interface group.Inputs
Outputs
[Family: cluster]
Create a new network interface group.Inputs
Outputs
[Family: cluster]
Destroy an existing network interface group.Inputs
Outputs
[Family: cluster]
Get the attributes of a network interface group (ifgrp).Inputs
Outputs
[Family: cluster]
Remove port from a network interface group.Inputs
Outputs
[Family: cluster]
Modify the given attributes of network port and the rest remain unchanged.Inputs
Outputs
[Family: cluster]
Modify the attributes of network port or a group of network port objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of QoS Marking attributesInputs
Outputs
[Family: cluster]
Modify the the QoS Marking attributes of a protocolInputs
Outputs
[Family: vserver]
Create a new network route.Inputs
Outputs
[Family: vserver]
Destroy an existing network route object.Inputs
Outputs
[Family: vserver]
Get the attributes of a network route.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network route objects.Inputs
Outputs
[Family: vserver]
Get the logical interfaces (LIFs) associated with a network route.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network route objects and get the associated logical interfaces (LIFs).Inputs
Outputs
[Family: cluster]
Create a new network routing group route.Inputs
Outputs
[Family: cluster]
Destroy an existing network routing group route.Inputs
Outputs
[Family: vserver]
Get the attributes of a network routing group route.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network routing group route.Inputs
Outputs
[Family: cluster]
Get the attributes of the SAN LIF Placement.Inputs
Outputs
[Family: cluster]
Add address ranges to a subnet.Inputs
Outputs
[Family: cluster]
Create a new subnet object. A subnet object represents a layer 3 subnet in a network.Inputs
Outputs
[Family: cluster]
Destroy an existing subnet object.Inputs
Outputs
[Family: cluster]
Get the attributes of the subnet object.Inputs
Outputs
[Family: cluster]
Iterate over a list of subnet objects.Inputs
Outputs
[Family: cluster]
Modify an existing subnet object.Inputs
Outputs
[Family: cluster]
Remove address ranges from a subnet.Inputs
Outputs
[Family: cluster]
Rename a layer 3 subnet.Inputs
Outputs
[Family: cluster]
Get the list of subnets associated with the layer 2 broadcast domain object.Inputs
Outputs
[Family: cluster]
Iterate over a list of subnets associated with the layer 2 broadcast domain objects.Inputs
Outputs
[Family: cluster]
Test performance between specified nodesInputs
Outputs
[Family: cluster, vserver]
Trace the route IPv6 packets take to a host. The input node is exclusive with the interface input. Only one is allowed. The interface input must be specified with interface owner.Inputs
Outputs
[Family: cluster]
Get ICMP tuning options.Inputs
Outputs
[Family: cluster]
Modify ICMP tuning optionsInputs
Outputs
[Family: cluster]
Get ICMPv6 tuning options.Inputs
Outputs
[Family: cluster]
Modify ICMPv6 tuning optionsInputs
Outputs
[Family: cluster]
Get TCP tuning options.Inputs
Outputs
[Family: cluster]
Modify TCP tuning optionsInputs
Outputs
[Family: cluster]
Create a new VIP port.Inputs
Outputs
[Family: cluster]
Delete a VIP port.Inputs
Outputs
[Family: cluster]
Get the attributes of a VIP port.Inputs
Outputs
[Family: cluster]
Iterate over a list of VIP ports.Inputs
Outputs
[Family: cluster]
Create a new vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.Inputs
Outputs
[Family: cluster]
Delete a vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.Inputs
Outputs
[Family: cluster]
Get the attributes of a VLAN.Inputs
Outputs
[Family: cluster]
Iterate over a list of VLAN objects.Inputs
Outputs
[Family: cluster, vserver]
Destroy an existing netgroups file configuration.Inputs
Outputs
[Family: cluster, vserver]
Get netgroups file configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of netgroups file configurations.Inputs
Outputs
[Family: vserver]
In Data ONTAP 7-Mode, this API will disable NFS server access (effectively same as the CLI command "nfs off") In Data ONTAP Cluster-Mode, this will stop the Vserver's NFS service. If the NFS service was not explicitly created, this API does nothing.Inputs
Outputs
[Family: vserver]
In Data ONTAP 7-Mode, this API will enable NFS server access (effectively same as the CLI command "nfs on") In Data ONTAP Cluster-Mode, this will start the Vserver's NFS service. If the NFS service was not explicitly created, this API will create one with default options.Inputs
Outputs
[Family: vserver]
Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.Inputs
Outputs
[Family: vserver]
Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent. The new security-rule-info structure contains finer grained information about security rules than exports-rule-info.Inputs
Outputs
[Family: vserver]
Returns true if the host IP has mount permissions for a specified path.Inputs
Outputs
[Family: vserver]
Removes the rules for a set of pathnames. This returns an error if any of the pathnames don't have a rule. In the Data ONTAP 7-Mode, set the persistent option to modify the etc/exports file and keep this change persistent upon reboots whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.Inputs
Outputs
[Family: vserver]
Returns the export rules that were configured with a single security flavor. If a pathname is specified, the rules associated with the export matching that pathname are returned; otherwise, rules for all exports are returned.Inputs
Outputs
[Family: vserver]
Returns the export rules that were configured with more than one security flavor, using the new security info structure. If a pathname is specified, the rules associated with the export matching that pathname are returned; otherwise, rules for all exports are returned.Inputs
Outputs
[Family: vserver]
Functionally similar to append with the following caveats. In Data ONTAP 7-Mode, returns an error if the rule does not exist. In Data ONTAP Cluster-Mode, returns an error if the export policy associated with the path doesn't contain any rules. Only works for one rule at a time.Inputs
Outputs
[Family: vserver]
Functionally similar to append-2 with the following caveats. In Data ONTAP 7-Mode, returns an error if the rule does not exist. In Data ONTAP Cluster-Mode, returns an error if the export policy associated with the path doesn't contain any rules. Only works for one rule at a time.Inputs
Outputs
[Family: vserver]
Returns a list of currently supported security flavors. Hosts with permmisions and connecting via the proper security flavor have access to directories on the filer. Default security flavor for all exports is "sys".Inputs
Outputs
[Family: vserver]
Create a new NFS configuration.Inputs
Outputs
[Family: vserver]
Delete an NFS configuration.Inputs
Outputs
[Family: vserver]
Get the NFS server configuration.Inputs
Outputs
[Family: cluster, vserver]
Obtain the default values for NFS server configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of NFS servers.Inputs
Outputs
[Family: vserver]
Modify an NFS configuration. If no values are given, the NFS configuration is not modified.Inputs
Outputs
[Family: vserver]
Returns the status of the NFS server.Inputs
Outputs
[Family: vserver]
Create an NIS domain configuration. Multiple NIS domains can be configured on a single Vserver, but only one NIS domain can be active at any given time.Inputs
Outputs
[Family: vserver]
Destroy an existing NIS configuration.Inputs
Outputs
[Family: vserver]
Get NIS domain configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NIS configurations.Inputs
Outputs
[Family: vserver]
Modify the attributes of NIS configuration.Inputs
Outputs
[Family: cluster]
Creates a configuration for an external time server to be used by NTP.Inputs
Outputs
[Family: cluster]
Remove a configuration for an external time server used by NTP.Inputs
Outputs
[Family: cluster]
Get the configuration of an external time server used by NTP.Inputs
Outputs
[Family: cluster]
Get the configuration of all the external time servers used by NTP.Inputs
Outputs
[Family: cluster]
Create an NTP symmetric authentication key.Inputs
Outputs
[Family: cluster]
Remove an NTP symmetric authentication key.Inputs
Outputs
[Family: cluster]
Get the configuration of all NTP symmetric authentication keys.Inputs
Outputs
[Family: cluster]
Modify an NTP symmetric authentication key.Inputs
Outputs
[Family: cluster]
Modify a configuration for an external time server used by NTP.Inputs
Outputs
[Family: cluster]
Reset the external NTP server list to the desired default values. The table is emptied and then populated to the desired default values.Inputs
Outputs
[Family: cluster]
Get the NTP security settings.Inputs
Outputs
[Family: cluster]
Set the NTP security settings.Inputs
Outputs
[Family: cluster]
Get the status of the selection of an external time server.Inputs
Outputs
[Family: cluster]
Get the status of the selection of all configured external time servers.Inputs
Outputs
[Family: cluster]
Validate an existing NTP external time server and report any validation problemsInputs
Outputs
[Family: vserver]
Create a new NVMe target service.Inputs
Outputs
[Family: vserver]
Delete an existing NVMe target service object.Inputs
Outputs
[Family: cluster]
Get the enabled NVMe over Fabrics featuresInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe target service objects.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe Interface objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of NVMe target service object.Inputs
Outputs
[Family: vserver]
Create a new NVMe target namespace.Inputs
Outputs
[Family: vserver]
Delete the namespaceInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe target namespace objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of NVMe target namespace object.Inputs
Outputs
[Family: cluster]
Displays the supported values and descriptions for nvme-namespace-os.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe subsystem controllers objects.Inputs
Outputs
[Family: vserver]
Create a new NVMe target subsystem.Inputs
Outputs
[Family: vserver]
Delete the subsystemInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe target subsystem objects.Inputs
Outputs
[Family: vserver]
Add a host to the subsystemInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe subsystem hosts objects.Inputs
Outputs
[Family: vserver]
Remove a host from the subsystemInputs
Outputs
[Family: vserver]
Add a namespace mapInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NVMe attached namespace objects.Inputs
Outputs
[Family: vserver]
Remove a namespace mapInputs
Outputs
[Family: vserver]
Modify the attributes of NVMe target subsystem object.Inputs
Outputs
[Family: cluster]
Displays the supported values and descriptions for nvme-subsystem-os.Inputs
Outputs
[Family: vserver]
Get the value of a single option.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of options objects.Inputs
Outputs
[Family: vserver]
Get a list of all optionsInputs
Outputs
[Family: cluster, vserver]
Modify the attributes of options or a group of options objects.Inputs
Outputs
[Family: vserver]
Set the value of a single option. For complete list of names and values of options, please refer to options man pages.Inputs
Outputs
[Family: cluster]
Display Cluster-Wide Performance Archive ConfigurationInputs
Outputs
[Family: cluster]
Modify Cluster-Wide Performance Archive ConfigurationInputs
Outputs
[Family: cluster]
Save a new Performance ArchiveInputs
Outputs
[Family: cluster]
API retrieves information about all the performance archive datastores in the cluster and their datafiles.Each performance archive-enabled process in the Data ONTAP cluster will have one or more datastores in which the archive datafiles are stored. These datastores encapsulate the archived performance data in groupings specified by the Data ONTAP cluster's performance preset configurations.
Inputs
Outputs
[Family: cluster]
Destroy a Performance ArchiveInputs
Outputs
[Family: cluster]
Iteratively get information about Performance ArchivesInputs
Outputs
[Family: cluster]
Modify properties of a Performance ArchiveInputs
Outputs
[Family: cluster]
Starting AWAInputs
Outputs
[Family: cluster]
Stoping AWAInputs
Outputs
[Family: cluster, vserver]
Get information about the counters of an object. This information is static and independent of any particular instance of the object. It includes counter names and descriptions, as well as properties which are necessary to to interpret counter values.Inputs
Outputs
[Family: cluster, vserver]
Get a list of current counter values of instances of an object. This will return the values of all specified counters and instances of the specified object with one call.Inputs
Either instances or instance-uuids input must be provided. The API errors out if both of these inputs are provided or neither of these inputs is provided, or if more than 500 instances are requested.
Outputs
[Family: cluster, vserver]
Gets the list of names and UUIDs of current instances of an object. This iterative API will return names and UUIDs of the current instances of the specified object; the number of records returned is specified by the max-records input element.To retrieve all the instances of the specified object, the value of the next-tag output element should be passed in as the value of the tag input element on the subsequent API call.
Inputs
Outputs
[Family: cluster, vserver]
Get list of performance objects in the system.Inputs
Outputs
[Family: cluster, vserver]
nullInputs
Outputs
[Family: cluster, vserver]
nullInputs
Outputs
[Family: cluster]
Create a single Performance Preset configuration and all of its detailsInputs
Outputs
[Family: cluster]
Delete a Performance Preset and all of its Preset DetailsInputs
Outputs
[Family: cluster]
Get detailed information about a single Performance Preset configurationInputs
Outputs
[Family: cluster]
Iteratively get information about Performance PresetsInputs
Outputs
[Family: cluster]
Import Performance Preset configuration from source URIInputs
Outputs
[Family: cluster]
Modify a Performance PresetInputs
Outputs
[Family: cluster, vserver]
nullInputs
Outputs
[Family: cluster, vserver]
Returns list of samplesInputs
Outputs
[Family: cluster]
Iterate over a list of Platform Capability Support objects.Inputs
Outputs
[Family: vserver]
Add a port to an existing port setInputs
Outputs
[Family: vserver]
Create a port setInputs
Outputs
[Family: vserver]
Destroys an existing port set. By default a set cannot be destroyed if there are existing igroup associated with that portset.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of portset objects.Inputs
Outputs
[Family: vserver]
Removes a port from a port set.Inputs
Outputs
[Family: cluster]
Get the attributes of an Cache policy.Inputs
Outputs
[Family: cluster]
Iterate over the list of available Cache policies.Inputs
Outputs
[Family: cluster]
Modify an existing Cache policy. Only default field in the row is modifiableInputs
Outputs
[Family: cluster]
Modify multiple Cache settingsInputs
Outputs
[Family: cluster]
Create an adaptive policy group. A unique name must be provided for the new adaptive policy group. A QoS adaptive policy group defines measurable Service Level Objectives (SLOs) that apply to the storage object with which the adaptive policy group is associated.Inputs
Outputs
[Family: cluster]
Delete single adaptive policy group. The default adaptive policy group may not be deleted. An error will be returned if the policy group is attached to any workloads unless 'force' is set to true.Inputs
Outputs
[Family: cluster]
Delete multiple policy groupsInputs
Outputs
[Family: cluster]
Get the attributes of an adaptive policy group.Inputs
Outputs
[Family: cluster]
Iterate over list of adaptive policy groups.Inputs
Outputs
[Family: cluster]
Modify an adaptive policy group.Inputs
Outputs
[Family: cluster]
Modify multiple adaptive policy groupsInputs
Outputs
[Family: cluster]
Rename a QoS adaptive policy groupInputs
Outputs
[Family: cluster]
Create a new policy. A unique name must be provided for the new policy, and a uuid will be returned. The policy will not affect any work until it is assigned to a workload. Therefore a workload referencing the policy should usually be created along with the policy.Inputs
Outputs
[Family: cluster]
Delete single policy. The policy may not be attached to any workloads. Only user defined policies may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple policies. The policies may not be attached to any workloads. Only user defined policies may be deleted.Inputs
Outputs
[Family: cluster]
Get the attributes of a policy.Inputs
Outputs
[Family: cluster]
Iterate over list of policies.Inputs
Outputs
[Family: cluster]
Create a policy group. A unique name must be provided for the new policy group. A QoS Policy group defines measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated.Inputs
Outputs
[Family: cluster]
Delete single policy group. The default policy group may not be deleted. An error will be returned if the policy group is attached to any workloads unless 'force' is set to true. Only user defined policy groups may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple policy groupsInputs
Outputs
[Family: cluster]
Get the attributes of a policy group.Inputs
Outputs
[Family: cluster]
Iterate over list of policy groups.Inputs
Outputs
[Family: cluster]
Modify an existing policy group.Inputs
Outputs
[Family: cluster]
Modify multiple policy groupsInputs
Outputs
[Family: cluster]
Rename a QoS Policy GroupInputs
Outputs
[Family: cluster]
Modify an existing policy.Inputs
Outputs
[Family: cluster]
Modify multiple policiesInputs
Outputs
[Family: cluster]
Create a new read-ahead policy. A unique name must be provided for the new read-ahead policy. If the 'default' field is set to true, these become the default read-ahead settings for policies that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead policies should usually be assigned to an existing QoS policy.Inputs
Outputs
[Family: cluster]
Delete single read-ahead policy. The default policy may not be deleted. The policy may not be attached to any workloads. Only user defined policies may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple read-ahead policies.Inputs
Outputs
[Family: cluster]
Get the attributes of a read-ahead policy.Inputs
Outputs
[Family: cluster]
Iterate over list of read-ahead policies.Inputs
Outputs
[Family: cluster]
Modify an existing read-ahead policy.Inputs
Outputs
[Family: cluster]
Modify multiple read-ahead policiesInputs
Outputs
[Family: cluster]
Get the cluster-wide QoS workload archival settings.Inputs
Outputs
[Family: cluster]
Modify the cluster-wide QoS workload archival settings.Inputs
Outputs
[Family: cluster]
Get the cluster-wide QoS control settings.Inputs
Outputs
[Family: cluster]
Modify the existing cluster-wide QoS control settings.Inputs
Outputs
[Family: cluster]
Create a new read-ahead setting. A unique name must be provided for the new read-ahead setting. If the 'default' field is set to true, these become the default read-ahead settings for settings that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead settings should usually be assigned to an existing QoS setting.Inputs
Outputs
[Family: cluster]
Destroy single read-ahead setting. The default setting may not be destroyed. The setting may not be attached to any workloads. Only user defined settings may be destroyed.Inputs
Outputs
[Family: cluster]
Destroy multiple read-ahead settings.Inputs
Outputs
[Family: cluster]
Get the attributes of a read-ahead setting.Inputs
Outputs
[Family: cluster]
Iterate over list of read-ahead settings.Inputs
Outputs
[Family: cluster]
Modify an existing read-ahead setting.Inputs
Outputs
[Family: cluster]
Modify multiple read-ahead settingsInputs
Outputs
[Family: cluster]
Create a new stream. A workload uuid and stream properties must be provided, and a new stream-id is returned.Inputs
Outputs
[Family: cluster]
Delete single stream.Inputs
Outputs
[Family: cluster]
Delete multiple streams.Inputs
Outputs
[Family: cluster]
Get the attributes of a stream.Inputs
Outputs
[Family: cluster]
Iterate over list of streams.Inputs
Outputs
[Family: cluster]
Returns SMF error with ZAPI error codesInputs
Outputs
[Family: cluster]
Create a new workload. A unique name must be provided for the new workload, and a uuid is returned. Subsequent management operations should index workloads by uuid as the name may be modified. No work will be classified to a workload unless the workload has at least one stream. Therefore at least one stream should usually be created along with a workload. If the performance of the workload is to be controlled by QoS, a policy must also be defined and attached to the workload.Inputs
Outputs
[Family: cluster]
Delete a single workload. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple workloads. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Delete single workload. This also deletes any streams attached to the workload. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple workloads. This also deletes any streams attached to the workloads. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Get the attributes of a workload.Inputs
Outputs
[Family: cluster]
Iterate over list of workloads.Inputs
Outputs
[Family: cluster]
Modify an existing workload. This may be used to rename the workload, modify the workload's ID, its class, or its category.Inputs
Outputs
[Family: cluster]
Modify multiple workloadsInputs
Outputs
[Family: cluster]
Get the cluster-wide QoS policy-group and workload count.Inputs
Outputs
[Family: vserver]
Create a new qtree.Inputs
For unclustered volumes, if this argument is missing, use the value specified in the option "wafl.default_qtree_mode".
For clustered volumes, if this argument is missing, the permissions of the volume is used.
Outputs
[Family: vserver]
Delete the specified qtree.For clustered volumes, all the quota rules that reference this qtree will be automatically deleted.
Inputs
For clustered volumes, if the qtree has a large number of files, it is recommended that the qtree-delete-async API be used.
Outputs
[Family: vserver]
Delete the specified qtree by spawning a background job. The jobid will be returned. The progress of the job can be tracked using the job APIs. All the quota rules that reference this qtree will be automatically deleted.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of qtrees in the cluster.Inputs
Outputs
[Family: vserver]
Modify the attributes of a qtree. If values are not provided for any of the fields, then that field will not be modified.Inputs
Outputs
[Family: vserver]
Renames the specified qtree to a new name specified by "new-qtree-name".For clustered volumes, the qtree name in the quota rules will be automatically updated with the new qtree name.
Inputs
Outputs
[Family: vserver]
Adds a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then an error is returned.Inputs
Outputs
[Family: vserver]
Deletes a quota entry specified by type, target, volume, and tree.Inputs
Outputs
[Family: vserver]
Obtains a quota entry specified by type, target, volume, and tree.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of quota rules in the cluster.Inputs
Outputs
[Family: vserver]
Modifys a quota entry. If the type, target, volume, and tree exist, the entry is modified. If the type, target, volume, and tree do not exist, then an error is returned.Inputs
Outputs
[Family: vserver]
Turns the quota subsystem off for a volume.For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Starts to turn quotas on for a volume. A successful return from this API does not mean that quotas are on, merely that an attempt to start it has been triggered. Use the quota-status API to check the status.For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: cluster, vserver]
Copy a quota policyInputs
Outputs
[Family: cluster, vserver]
Creates a quota policyInputs
Outputs
[Family: vserver]
Deletes a specified quota policyInputs
Outputs
[Family: cluster, vserver]
Deletes a list of specified quota policiesInputs
Outputs
[Family: cluster, vserver]
Return a list of quota policiesInputs
Outputs
[Family: cluster, vserver]
Rename a quota policyInputs
Outputs
[Family: vserver]
Get the attributes of the quota-policy-rule-count.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of quota-policy-rule-count objects.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the quota report in the cluster.Inputs
Outputs
[Family: vserver]
Starts an ONTAP operation to resize quotas for a volume. A successful return from this API does not mean that the operation has finished, merely that an attempt to start it been triggered. Use the quota-status API to check the status.For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Sets a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then the entry is modified.Inputs
Outputs
[Family: vserver]
Obtains the status of quotasInputs
Outputs
If a FlexGroup's constituents have differing quota statuses, the FlexGroup will return a 'mixed' quota status. If one or more of a FlexGroup's constituents are not online or otherwise cannot be reached, the FlexGroup will return an 'unknown' quota status.
If a FlexGroup's constituents have differing quota substatuses, the FlexGroup will return a 'mixed' quota substatus. If one or more of a FlexGroup's constituents are not online or otherwise cannot be reached, the FlexGroup will return an 'unknown' quota substatus.
[Family: cluster, vserver]
Iterate over quota status for all volumes in the clusterInputs
Outputs
[Family: cluster]
Get Claim-Name from Claim-cnInputs
Outputs
[Family: cluster]
Get the Active DC informartion give vfilerInputs
Outputs
[Family: cluster]
Get UNIX credentials from UNIX user IDInputs
Outputs
[Family: cluster]
Get UNIX credentials from UNIX User NameInputs
Outputs
[Family: cluster]
Get UNIX user ID from Windows SIDInputs
Outputs
[Family: cluster]
Get UNIX User Name from Windows SIDInputs
Outputs
[Family: cluster]
Translate Group ID to UNIX Group NameInputs
Outputs
[Family: cluster]
Translate SID to Windows User NameInputs
Outputs
[Family: cluster]
Translate user ID to UNIX User NameInputs
Outputs
[Family: cluster]
Translate UNIX Group Name to Group IDInputs
Outputs
[Family: cluster]
Translate UNIX User Name to user IDInputs
Outputs
[Family: cluster]
Translate Windows User Name to SIDInputs
Outputs
[Family: cluster]
Get Windows SID from UNIX user IDInputs
Outputs
[Family: vserver]
Get the SecD connection timeout value for a VserverInputs
Outputs
[Family: cluster, vserver]
Iterate through the SecD connection timeout values of the clusterInputs
Outputs
[Family: vserver]
Modify the SecD connection timeout value for a VserverInputs
Outputs
[Family: cluster]
DNS Forward Lookup for a HostnameInputs
Outputs
[Family: cluster]
DNS Lookup for SRV recordsInputs
Outputs
[Family: cluster]
Get the Mapping for input Group Name in particular DirectionInputs
Outputs
[Family: cluster]
Get Name Mappings configured for particular directionInputs
Outputs
[Family: cluster]
Host Information of the Discovered ServersInputs
Outputs
[Family: cluster]
Reset the Discovered ServersInputs
Outputs
[Family: cluster]
Site of the Discovered ServersInputs
Outputs
[Family: cluster]
Test the Discovered ServersInputs
Outputs
[Family: vserver]
nullInputs
Outputs
[Family: vserver]
Creates a new Security trace entry.Inputs
Outputs
[Family: vserver]
Deletes the specified Security trace entry.Inputs
Outputs
[Family: cluster, vserver]
Gives information about one or more Security trace entries.Inputs
Outputs
[Family: vserver]
Modifies settings of a Security trace entry, even if it is in use.Inputs
Outputs
[Family: vserver]
Delete the specified security tracing event record.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of permission tracing results for the cluster.Inputs
Outputs
[Family: cluster]
Display Cluster Security ConfigurationInputs
Outputs
[Family: cluster]
Modify Cluster Security ConfigurationInputs
Outputs
[Family: cluster]
Disable OCSP for one or more selected applicationsInputs
Possible values:
Outputs
[Family: cluster]
Enable OCSP for one or more selected applicationsInputs
Possible values:
Outputs
[Family: cluster]
Display OCSP Support Status for ApplicationsInputs
Outputs
[Family: cluster]
Show the last login time, unsuccessful login attempts and role change since last login.Inputs
Outputs
[Family: cluster]
Create a new user account associated with the specified application and authentication method. The new account can be local to ONTAP or an user/group configured in an external Active-Directory/LDAP/NIS server. In case of Active-Directory/LDAP/NIS group as the user account, access will be granted to its member users.Inputs
Outputs
[Family: cluster]
Delete an existing user account object.Inputs
Outputs
[Family: cluster]
Delete an existing user account or a group of user account objects.Inputs
Outputs
[Family: cluster]
If the user has a password enabled, this API will cause it to immediately expire. Current login sessions will still remain available.Inputs
Outputs
[Family: cluster]
Iterate over a list of user account that uses password as authentication method to immedialtely expire their passwords. Current login sessions will still remain available.Inputs
Outputs
[Family: cluster]
Get the attributes of a user account.Inputs
Outputs
[Family: cluster]
Iterate over a list of user account objects.Inputs
Outputs
[Family: cluster]
Lock a user account that uses password as the authentication method. Returns an error if the user account does not use password authentication.Inputs
Outputs
[Family: cluster]
Modify the attributes of a user account object. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Modify the attributes of a user account or a group of user account objects.Inputs
Outputs
[Family: cluster, vserver]
Changes the password of a specified user.Inputs
Outputs
[Family: cluster]
Get the attributes of a role configuration.Inputs
Outputs
[Family: cluster]
Iterate over a list of role objects.Inputs
Outputs
[Family: cluster]
Modify the specified attributes of role configuration object. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Modify the attributes of role configuration or a group of role configuration objects.Inputs
Outputs
[Family: cluster]
Create a new user role.Inputs
Outputs
[Family: cluster]
Delete an existing user role object.Inputs
Outputs
[Family: cluster]
Delete an existing user role or a group of user role objects.Inputs
Outputs
[Family: cluster]
Get the attributes of a user role.Inputs
Outputs
[Family: cluster]
Iterate over a list of user role objects.Inputs
Outputs
[Family: cluster]
Modify the attributes of user role object. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Modify the attributes of user role or a group of user role objects.Inputs
Outputs
[Family: cluster]
Unlock a user account that uses password as authentication method. Returns an error if the user account does not use password authentication.Inputs
Outputs
[Family: cluster, vserver]
Show the current user and role of this session.Inputs
Outputs
[Family: cluster]
Get the security protocol configurationInputs
Outputs
[Family: cluster]
Modify the security protocol configurationInputs
Outputs
[Family: cluster]
Get the security protocol ssh configurationInputs
Outputs
[Family: cluster]
Modifies the security protocol ssh configuration.Inputs
Outputs
[Family: cluster]
Configure SAML service provider information. Note that this restarts the web server. Any HTTP/S connections that are active will be disrupted.Inputs
Outputs
[Family: cluster]
Delete SAML service provider configuration information. Note that this restarts the web server. Any HTTP/S connections that are active will be disrupted.Inputs
Outputs
[Family: cluster]
Get SAML service provider configuration informationInputs
Outputs
[Family: cluster]
Modify SAML service provider configuration information. Note that this may restart the web server. Any HTTP/S connections that are active may be disrupted. Prior to disabling SAML service provider authentication, to prevent losing access, ensure that there are user accounts configured for non-SAML authentication.Inputs
Outputs
[Family: cluster, vserver]
Adds the input algorithms, ciphers and mac algorithms to the SSH configuration. Existing algorithms, ciphers and mac algorithms remain in the configuration. API will succeed if requested kex algorithm or cipher or MAC algorithm is not currently enabled in the configuration.Inputs
Outputs
[Family: cluster, vserver]
Display SSH configuration optionsInputs
Outputs
[Family: cluster, vserver]
Removes the input algorithms, ciphers and MAC algorithms from the SSH configuration. API will succeed if requested kex algorithm or cipher or MAC algorithm is already currently enabled in the configuration.Inputs
Outputs
[Family: vserver]
Enable and replace SSH configuration options to this new settingInputs
Outputs
[Family: vserver]
Get the attributes of the security-certificate-ca-issued.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of security-certificate-ca-issued objects.Inputs
Outputs
[Family: cluster, vserver]
If a certificate is created with the existing Common Name then a new certificate is generated with a different serial numberInputs
Possible values:
Possible values:
Possible values:
Outputs
[Family: cluster, vserver]
Delete an existing security-certificate object.Inputs
Possible values:
Outputs
[Family: cluster, vserver]
Delete an existing security-certificate or a group of security-certificate objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of security-certificate-file objects.Inputs
Outputs
[Family: cluster, vserver]
Generate a digital certificate signing request(CSR)Inputs
Possible values:
Possible values:
Outputs
[Family: vserver]
Get the attributes of the security-certificate.Inputs
Possible values:
Outputs
[Family: cluster, vserver]
Iterate over a list of security-certificate objects.Inputs
Outputs
[Family: cluster, vserver]
Install a digital certificateInputs
Possible values:
Outputs
[Family: cluster]
Removes the auto-generated precluster certificateInputs
Outputs
[Family: cluster, vserver]
Rename a digital certificate.Inputs
Outputs
[Family: cluster, vserver]
Revoke a digital certificateInputs
Outputs
[Family: cluster, vserver]
Sign a certificate using self-signed root CAInputs
Possible values:
Possible values:
Outputs
[Family: cluster]
Clear the default root certificates from truststoreInputs
Outputs
[Family: cluster]
Load the default root certificates to truststoreInputs
Outputs
[Family: cluster, vserver]
Restore the key IDs from all the key management servers known to this cluster.Inputs
Outputs
[Family: cluster, vserver]
Lists the connectivity status for all key management servers known to the cluster.Inputs
Outputs
[Family: cluster, vserver]
Lists the keys in the key managers.Inputs
Outputs
[Family: cluster]
Add a key management server to Data ONTAP. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
(DEPRECATED)-Add a key management server to each node in the cluster.Inputs
Outputs
[Family: cluster]
Get backup of key hierarchy. Deprecated as of ONTAP 9.6 and might be removed in a future release.Inputs
Outputs
[Family: cluster]
(DEPRECATED)-Update Key Manager SSL CertificateInputs
Outputs
[Family: cluster]
Display Key Management ConfigurationInputs
Outputs
[Family: cluster]
Modify Key Management ConfigurationInputs
Outputs
[Family: cluster]
Create a new authentication key with the key management servers. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Delete a key management server from Data ONTAP. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
(DEPRECATED)-Delete a key management server from Data ONTAPInputs
Outputs
[Family: cluster]
Deletes the key hierarchy for onboard key manager. Deprecated as of ONTAP 9.6 and might be removed in a future release.Inputs
Outputs
[Family: cluster]
Deletes the KMIP configuration. Deprecated as of ONTAP 9.6 and might be removed in a future release.Inputs
Outputs
[Family: cluster, vserver]
Add additional external key management serversInputs
Outputs
[Family: cluster, vserver]
Disable external key managementInputs
Outputs
[Family: cluster, vserver]
Enable external key managementInputs
Outputs
[Family: vserver]
Get information about a registered key management server.Inputs
Outputs
[Family: cluster, vserver]
Lists registered key management servers known to the cluster.Inputs
Outputs
[Family: cluster, vserver]
Modify external key managementInputs
Outputs
[Family: cluster, vserver]
Modify information about an external key management serverInputs
Outputs
[Family: cluster, vserver]
Remove external key management serversInputs
Outputs
[Family: cluster]
Lists all registered key management servers known to a specified node. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Lists registered key management servers known to the cluster. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Create a new authentication key on the key managerInputs
Outputs
[Family: cluster]
Delete an existing authentication key on the key managerInputs
Outputs
[Family: cluster, vserver]
Migrate keys from one vserver to anotherInputs
Outputs
[Family: cluster, vserver]
Lists all configured key managers.Inputs
Outputs
[Family: cluster, vserver]
Get backup of key hierarchyInputs
Outputs
[Family: cluster]
Disable onboard key managementInputs
Outputs
[Family: cluster]
Enable Onboard Key ManagerInputs
Outputs
[Family: cluster]
Sync Onboard Key Management KeysInputs
Outputs
[Family: cluster]
Update the Onboard Key Management PassphraseInputs
Outputs
[Family: cluster]
(DEPRECATED)-Return the key IDs stored in a key management server and whether restored (present in the node's key table).Inputs
Outputs
[Family: cluster]
(DEPRECATED)-Return the key IDs stored in all of the key management servers known to the cluster and whether restored (present in the nodes' key tables).Inputs
Outputs
[Family: cluster]
Return the key IDs stored in a key management server and whether restored (present in the node's key table). Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Return the key IDs stored in all of the key management servers known to the cluster and whether restored (present in the nodes' key tables). Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
(DEPRECATED)-Restore the key IDs stored in the specified key management server for the specified node.Inputs
Outputs
[Family: cluster]
(DEPRECATED)-Restore the key IDs from all the key management servers known to this cluster.Inputs
Outputs
[Family: cluster]
Restore the key IDs from the specified key management server for the specified node. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Restore the key IDs from all the key management servers known to this cluster. Deprecated as of ONTAP 9.6 and may be removed in a future release.Inputs
Outputs
[Family: cluster]
Configure key manager connectivity. Deprecated as of ONTAP 9.6 and might be removed in a future release.Inputs
Outputs
[Family: cluster]
Update passphrase for onboard key management. Deprecated as of ONTAP 9.6 and might be removed in a future release.Inputs
Outputs
[Family: cluster]
Checks if Volume encryption is supported on this nodeInputs
Outputs
[Family: cluster]
Show information related to the keys present in the cluster. Deprecated as of ONTAP 9.6 and might be removed in a future release.Inputs
Outputs
[Family: cluster]
Returns session application statistics.Inputs
Outputs
[Family: cluster]
Kill a CLI sessionInputs
Outputs
[Family: cluster]
Creates a per-application session limit.Inputs
Outputs
[Family: cluster]
Deletes a per-application session limit.Inputs
Outputs
[Family: cluster]
Returns per-application session limits.Inputs
Outputs
[Family: cluster]
Modifies a per-application session limit.Inputs
Outputs
[Family: cluster]
Creates a session default limit.Inputs
Outputs
[Family: cluster]
Deletes a session default limit.Inputs
Outputs
[Family: cluster]
Returns session default limits.Inputs
Outputs
[Family: cluster]
Creates a per-location session limit.Inputs
Outputs
[Family: cluster]
Deletes a per-location session limit.Inputs
Outputs
[Family: cluster]
Returns per-location session limits.Inputs
Outputs
[Family: cluster]
Modifies a per-location session limit.Inputs
Outputs
[Family: cluster]
Modifies a session default limit.Inputs
Outputs
[Family: cluster]
Creates a per-request session limit.Inputs
Outputs
[Family: cluster]
Deletes a per-request session limit.Inputs
Outputs
[Family: cluster]
Returns per-request session limits.Inputs
Outputs
[Family: cluster]
Modifies a per-request session limit.Inputs
Outputs
[Family: cluster]
Creates a per-user session limit.Inputs
Outputs
[Family: cluster]
Deletes a per-user session limit.Inputs
Outputs
[Family: cluster]
Returns per-user session limits.Inputs
Outputs
[Family: cluster]
Modifies a per-user session limit.Inputs
Outputs
[Family: cluster]
Creates a per-vserver session limit.Inputs
Outputs
[Family: cluster]
Deletes a per-vserver session limit.Inputs
Outputs
[Family: cluster]
Returns per-vserver session limits.Inputs
Outputs
[Family: cluster]
Modifies a per-vserver session limit.Inputs
Outputs
[Family: cluster]
Returns session location statistics.Inputs
Outputs
[Family: cluster]
Returns session request statistics.Inputs
Outputs
[Family: cluster]
Returns session running statistics.Inputs
Outputs
[Family: cluster]
Returns session user statistics.Inputs
Outputs
[Family: cluster]
Returns session vserver statistics.Inputs
Outputs
[Family: vserver]
Get the attributes of SSL securityInputs
Outputs
[Family: cluster, vserver]
Get the attributes of SSL securityInputs
Outputs
[Family: cluster, vserver]
Modify SSL authentication for a Vserver. Only field(s) that are provided will be modified.Inputs
Outputs
[Family: cluster, vserver]
Disable user-installed certificates for the service processor API service - use auto-generated certificatesInputs
Outputs
[Family: cluster, vserver]
Enable user-installed certificates for the service processor API serviceInputs
Outputs
[Family: cluster]
Get service processor API service configurationInputs
Outputs
[Family: cluster]
Modify service processor API service configurationInputs
Outputs
[Family: cluster]
Renew SSL and SSH certificates used for secure communication with Service Processor Cluster ServicesInputs
Outputs
[Family: cluster, vserver]
Generate SSL and SSH certificates used for secure communication with the service processor API serviceInputs
Outputs
[Family: cluster]
Returns Service Processor AutoSupport Configuration Information.Inputs
Outputs
[Family: cluster]
Setup Service Processor AutoSupport Configuration Information.Inputs
Outputs
[Family: cluster]
Invoke AutoSupport from Specific Service-ProcessorInputs
Outputs
[Family: cluster]
Disable Service Processor Auto-ConfigurationInputs
Outputs
[Family: cluster]
Enable Service Processor Auto-ConfigurationInputs
Outputs
[Family: cluster]
Get Service Processor auto-configuration subnet name.Inputs
Outputs
[Family: cluster]
Get basic information about the deviceInputs
Outputs
[Family: cluster]
Get basic information about device of each node in the clusterInputs
Outputs
[Family: cluster]
Get information about installed firmware imagesInputs
Outputs
[Family: cluster]
Enable or disable automatic firmware updateInputs
Outputs
[Family: cluster]
Install new firmware imageInputs
Outputs
[Family: cluster]
Get firmware update progressInputs
Outputs
[Family: cluster]
Get the Service Processor log allocation map.Inputs
Outputs
[Family: cluster]
Get the Service Processor log allocation map of each node in the cluster.Inputs
Outputs
[Family: cluster]
Get the network configurationInputs
Outputs
[Family: cluster]
Get the network configuration of device of each node in the clusterInputs
Outputs
[Family: cluster]
Modify the network configurationInputs
Outputs
[Family: cluster]
Modify the network configuration of device of each node in the clusterInputs
Outputs
[Family: cluster]
Reboot the Service ProcessorInputs
Outputs
[Family: cluster]
Add IP addresses that are allowed to access the Service ProcessorInputs
Outputs
[Family: cluster]
Return SSH security information about the Service Processor.Inputs
Outputs
[Family: cluster]
Remove IP addresses that are allowed to access the Service ProcessorInputs
Outputs
[Family: cluster]
Returns information about storage shelf bays and ports for a selected number of shelves, or optionally all shelves connected to the storage controller.Inputs
Outputs
[Family: cluster]
Returns the environmental information for a selected number of shelves, or optionally all shelves connected to the storage controller.Inputs
Outputs
[Family: cluster]
This returns information about an identified shelf. The information is the number of bays present (bay-count), and which shelf bays have drives (bay-list). Shelf bays are numbered from 0 to bay-count minus 1. Shelf bay 0 is always on the right when looking at the front of the shelf. Incidentally, the bay-list may be empty indicating the absence of any drives. However, there are some shelf designs which require a disk drive in bay 0 or 1 for any SES functionality to operate (e.g., DS14 and DS14-Mk2-FC). In these cases, shelves without drives in bay 0 or 1 will not be listed.Inputs
Outputs
[Family: cluster]
This interface returns information about one or more shelves.Inputs
Outputs
[Family: vserver]
Disable sis on a volume. If the sis operation is active on the volume, it needs to be stopped by "sis-stop" API before disabling.This API is not supported for FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Disable sis on a FlexGroup or an Infinite Volume. If the sis operation is active on the volume, it needs to be stopped by "sis-stop-async" API before disabling.This API is not supported for Flexible Volumes, FlexGroup constituents, Infinite Volume constituents, or Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: vserver]
Enable sis on a volume.On a non-SnapVault secondary volume, the sis operation will be started periodically according to a per-volume schedule. By default, this schedule is sun-sat@0. (Everyday at 0:00 hours) On a SnapVault secondary volume, the sis operation will be kicked off at the end of the SnapVault transfer. This API does not enable compression on the volume. See the "sis-set-config" API for options to enable compression and for modifying the default schedule set on the volume. A sis operation can also be manually started using the sis-start API.
This API is not supported for FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Enable sis on a FlexGroup or an Infinite Volume.This is similar to 'sis-enable' API except that it operates on a FlexGroup or Infinite Volume. Read about 'sis-enable' API for specific details.
This API is not supported for Flexible Volumes, FlexGroup constituents, Infinite Volume constituents, or Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: vserver]
Get status of a sis volume.This API is not supported on Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of sis volumes.This API is not supported on Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: vserver]
Create a new sis policy.Inputs
Outputs
[Family: vserver]
Delete a sis policy.Inputs
Outputs
[Family: vserver]
Get attributes of a sis policy.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of sis policy objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of a sis policy.Inputs
Outputs
[Family: vserver]
Setup or modify sis policy, schedule or options for a volume.This API is not supported for FlexGroups or Infinite Volumes.
Inputs
Enabling compression on a secondary volume is strongly discouraged. If compression is enabled on a secondary volume, storage efficiency present on the source will not be preserved during replication. The destination system needs to run offline storage efficiency scanner (compression and dedupe) to achieve storage savings. Additional compression savings on the destination comes at a cost of extra computation resources. In environments where there is a lot of shared data present on the source, (e.g., virtualized environments employing file clones), data inflation during transfer may lead to failed backups due to lack of space on the secondary volume.
The format of the schedule:
day_list[@hour_list] or hour_list[@day_list] or - or auto or manual
The day_list specifies which days of the week the sis operation should run. It is a comma-separated list of the first three letters of the day: sun, mon, tue, wed, thu, fri, sat. The names are not case sensitive. Day ranges such as mon-fri can also be given. The default day_list is sun-sat.
The hour_list specifies which hours of the day the sis operation should run on each scheduled day. The hour_list is a comma-separated list of the integers from 0 to 23. Hour ranges such as 8-17 are allowed. Step values can be used in conjunction with ranges. For example, 0-23/2 means "every two hours". The default hour_list is 0, i.e. midnight on the morning of each scheduled day.
If "-" is specified, no schedule is set. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If schedule is passed, any previous policy-name set on the volume is automatically reset.
The "auto" schedule string means the sis operation will be triggered by the amount of new data written to the volume. The criterion is subject to being changed later.
The "manual" schedule string prevents SIS from automatically triggering any operations and disables change-logging. This schedule string can only be used on SnapVault destination volumes. The use of this schedule is mainly desirable when inline compression is enabled on a SnapVault destination volume and background processing is not necessary.
Outputs
[Family: vserver]
Setup or modify sis policy, schedule or options for a volume.This API is not supported for Flexible Volumes, FlexGroup constituents, Infinite Volume constituents, or Infinite Volumes that are managed by storage services.
Inputs
The format of the schedule:
day_list[@hour_list] or hour_list[@day_list] or - or auto or manual
The day_list specifies which days of the week the sis operation should run. It is a comma-separated list of the first three letters of the day: sun, mon, tue, wed, thu, fri, sat. The names are not case sensitive. Day ranges such as mon-fri can also be given. The default day_list is sun-sat.
The hour_list specifies which hours of the day the sis operation should run on each scheduled day. The hour_list is a comma-separated list of the integers from 0 to 23. Hour ranges such as 8-17 are allowed. Step values can be used in conjunction with ranges. For example, 0-23/2 means "every two hours". The default hour_list is 0, i.e. midnight on the morning of each scheduled day.
If "-" is specified, no schedule is set. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If schedule is passed, any previous policy-name set on the volume is automatically reset.
The "auto" schedule string means the sis operation will be triggered by the amount of new data written to the volume. The criterion is subject to being changed later.
If "manual" is specified, sis operation will never be triggered automatically. Only the user can manually execute the sis operation.
Outputs
[Family: vserver]
Start a sis operation on a volume. The volume must have sis enabled, before starting a sis operation. If the sis operation is already active on the volume, this API will fail.This API is not supported for FlexGroups or Infinite Volumes.
Inputs
The scan will include whatever is enabled on the volume. For example: If compression is not enabled on the volume, the scan will not include compression. This default behavior can be changed by using the run-dedupe-scan and run-compression-scan parameters.
If scan is false only data added since the last sis operation will be processed. Default value: "false"
Outputs
[Family: vserver]
Start a sis operation on FlexGroup or an Infinite Volume. The volume must have sis enabled, before starting a sis operation. If the sis operation is already active on the volume, this API will fail.This API is not supported for Flexible Volumes, FlexGroup constituents, Infinite Volume constituents, or Infinite Volumes that are managed by storage services.
Inputs
The scan will include whatever is enabled on the volume. For example: If compression is not enabled on the volume, the scan will not include compression. This default behavior can be changed by using the run-dedupe-scan and run-compression-scan parameters.
If scan is false only data added since the last sis operation will be processed. Default value: "false"
Outputs
[Family: cluster, vserver]
Get Status of a sis volume This API is not optimal for use in Data ONTAP Cluster-Mode systems, and is deprecated. Use sis-get and sis-get-iter APIs for Data ONTAP Cluster Mode systems. This API is still supported for Data ONTAP 7-Mode systems.Inputs
Outputs
[Family: vserver]
Abort currently active sis operation on the volume. The sis operation will remain paused and the operation can be resumed by "sis-start", SnapVault transfer, or the scheduler.This API is not supported for FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Abort currently active sis operation on the FlexGroup or Infinite Volume. The sis operation will remain paused and the operation can be resumed by "sis-start-async" or the scheduler.This API is not supported for Flexible Volumes, FlexGroup constituents, Infinite Volume constituents, or Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: vserver]
Create a new SnapDiff RPC Server configuration.Inputs
Outputs
[Family: vserver]
Delete an SnapDiff RPC Server configuration.Inputs
Outputs
[Family: vserver]
Stop the SnapDiff RPC ServerInputs
Outputs
[Family: vserver]
Start the SnapDiff RPC ServerInputs
Outputs
[Family: vserver]
Get the SnapDiff RPC Server configuration.Inputs
Outputs
[Family: cluster, vserver]
Obtain the default values for SnapDiff RPC Server configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of SnapDiff RPC Server configurations.Inputs
Outputs
[Family: vserver]
Modify an SnapDiff RPC Server configuration. If no values are given, the configuration is not modified.Inputs
Outputs
[Family: vserver]
Archive the active worm log file. This will close the current log file for furthur updates and it will open a new log file to write future log updates A job will be spawned to operate on the snaplock and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Create audit log configuration for a Vserver.Inputs
Outputs
[Family: vserver]
Delete audit log configuration for a Vserver.Inputs
Outputs
[Family: vserver]
The snaplock-event-retention-abort API can be used to abort an ongoing Event Based Retention operation. This API only aborts operations that have started and not finished. The operation ID of the operation must be specified.Inputs
Outputs
[Family: vserver]
The snaplock-event-retention-apply-start API can be used to apply an Event Based Retention policy to files present under the specified path. Use the snaplock-event-retention-show API to display the status of the operation.Inputs
Outputs
[Family: cluster, vserver]
This API can be used to display the status of an Event Based Retention operation.Inputs
Outputs
[Family: vserver]
Create SnapLock Event Based Retention policies.Inputs
Outputs
[Family: vserver]
Delete SnapLock Event Based Retention policies.Inputs
Outputs
[Family: cluster, vserver]
Get SnapLock Event Based Retention policies.Inputs
Outputs
[Family: vserver]
Modify SnapLock Event Based Retention policies.Inputs
Outputs
[Family: vserver]
Executes a privileged delete on a SnapLock file A job will be spawned to operate on the snaplock and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Display the NTP sync option setting.Inputs
Outputs
[Family: vserver]
Get retention time of a file protected by SnapLock.Inputs
Outputs
[Family: cluster]
Get the SnapLock Node ComplianceClock date and time.Inputs
Outputs
[Family: cluster, vserver]
Display Status of Active SnapLock Log Files.Inputs
Outputs
[Family: cluster, vserver]
Display audit Log configuration.Inputs
Outputs
[Family: vserver]
This API is used to abort an ongoing legal-hold operation. This API only aborts legal-hold operations that have started and not finished. The operation ID of the legal-hold operation must be specified.Inputs
Outputs
[Family: vserver]
This API starts an operation to put files in user specified path under legal-hold. The progress of the operation can be monitored using snaplock-legal-hold-get-iter api.Inputs
Outputs
[Family: vserver]
Dump the list of files under legal hold for a given volume and litigation to a user specified output path. The progress of the operation can be monitored using snaplock-legal-hold-get-iter api.Inputs
Outputs
[Family: vserver]
Dump the list of litigations to a user specified output path. The progress of the operation can be monitored using job-get api. A job will be spawned to operate on the snaplock and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
This API starts an operation to release legal-hold on files in user specified path. The progress of the operation can be monitored using snaplock-legal-hold-get-iter api.Inputs
Outputs
[Family: cluster, vserver]
This API is used to retrieve the status of legal-hold operations.Inputs
Outputs
[Family: cluster]
Modify the NTP sync option.Inputs
Outputs
[Family: vserver]
Modify audit log configuration for a Vserver.Inputs
Outputs
[Family: vserver]
Set retention time of a file. User can specify either retention-time or set-infinite-retention. If neither the retention-time nor set-infinite-retention is specified, the file will get committed to WORM with default retention period.Inputs
Outputs
[Family: cluster]
Set the ComplianceClock of the node equal to the current system clock.Inputs
Outputs
[Family: vserver]
The volume-set-privileged-delete API is used to set the SnapLock privileged-delete attibute on a Snaplock enterprise volume. The privileged-delete attibute can be set to one of the following values:Inputs
Outputs
[Family: vserver]
Returns snaplock attributes of a given snaplock volume.Inputs
Outputs
[Family: vserver]
Sets the given snaplock attributes of a snaplock volume.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-abort API stops ongoing transfers for a SnapMirror relationship. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using snapmirror-abort. On Data ONTAP operating in Cluster-Mode, the snapmirror-abort API stops all of the active transfers to each associated volume on the receiving side in a set of load-sharing mirrors. Load-sharing mirrors are either up to date and serving data to clients, or they are lagging and not serving data to clients. If the snapmirror-abort API identifies an up-to-date load-sharing mirror, then SnapMirror transfers to associated up-to-date load-sharing mirrors in the set of load-sharing mirrors are also aborted. If the snapmirror-abort API identifies a lagging load-sharing mirror, then only the SnapMirror transfer associated with the lagging load-sharing mirror is aborted. After the snapmirror-abort API successfully completes its operation, the volume on the receiving side of the transfer might contain a restart checkpoint. The restart checkpoint can be used by a subsequent transfer to restart and continue the aborted SnapMirror transfer. Snapmirror-abort API must be used from the destination storage system on Data ONTAP operating in 7-Mode, from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, from the destination Vserver or cluster on Data ONTAP 8.2 or later operating in Cluster-Mode.This API is not supported if the destination end point is an Infinite Volume.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-abort-async API stops ongoing transfer for a SnapMirror relationship on Infinite Volume. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using the snapmirror-abort-async API. The destination endpoint could be aInputs
Outputs
[Family: cluster, vserver]
The snapmirror-abort-iter API aborts SnapMirror transfers for one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster, vserver]
Add a list of source volume paths to the SnapMirror auto protection exclusion list.Inputs
Outputs
[Family: cluster, vserver]
Disable SnapMirror auto protection for a source Vserver.Inputs
Outputs
[Family: cluster, vserver]
Enable SnapMirror auto protection for a source Vserver.Inputs
Outputs
[Family: cluster, vserver]
Remove a list of source volume paths from the SnapMirror auto protection exclusion list.Inputs
Outputs
[Family: cluster, vserver]
Breaks a SnapMirror relationship between a source and destination volume data protection mirror. When Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy.On Data ONTAP operating in 7-Mode, no check is done to determine whether the operation is legal or successful. You need to query the status afterward by using the snapmirror-get-status API.
Subsequent manual or scheduled SnapMirror updates to the broken relationship will fail until the SnapMirror relationship is re-established using the snapmirror-resync API.
On Data ONTAP operating in Cluster-Mode, this API applies only to data protection mirrors and not to load-sharing mirrors.
The snapmirror-break API must be issued on destination storage system on Data ONTAP operating in 7-Mode, and on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination cluster or Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.
This API is not supported if the destination end point is an Infinite Volume.
This API is not supported if the destination is a non-Data ONTAP endpoint.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-break-async API breaks a SnapMirror relationship between a source Infinite Volume and a destination Infinte volume or a source Vserver and destination Vserver. For Infinite volume SnapMirror relationship, when Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy. You must specify the destination endpoint when using snapmirror-break-async. The destination endpoint could be aInputs
Outputs
[Family: cluster, vserver]
The snapmirror-break-iter API breaks one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-capabilities-get API returns capabilities information for an endpoint type. It is supported only for the FlexVol endpoint type. It is not supported for FlexGroup, Infinite Volume, or non-Data ONTAP endpoint types. This API is available in Data ONTAP 9.3 and later.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-capabilities-get API returns capabilities information for one or more endpoint types. It is only supported for the FlexVol endpoint type. It is not supported for FlexGroup, Infinite Volume or non-Data ONTAP endpoint types. This API is available in Data ONTAP 9.3 and later.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-check API starts an operation to compare the contents of a snapshot between the source volume and destination volume. You must specify the destination endpoint when using snapmirror-check.It is also possible to use the snapmirror-check command to compare only the contents of specific files or LUNs in specific Snapshot copies. A file-level check is run when the check-file-list, source-path, source-snapshot, and target-snapshot parameters are specified. Only the contents of the files specified in check-file-list are compared. You can also run a file-level check between volumes that are not in a SnapMirror relationship.
This API is not supported for relationships with AltaVault endpoints.
For FlexGroup relationships, there is no support in the checker to check the relationship at the FlexGroup level. The checker must be run on the constituent level relationships which are returned when the snapmirror-get-iter API specifying the expand parameter is used.
A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
The path to each file to be compared in the target snapshot on the destination volume is the same as the path specified by source-path unless an optional destination-path is specified. Destination-path begins with the @ symbol followed by the path of the file from the root of the target Snapshot copy on the destination volume, e.g. @ /file1 or @ /dira/lun1. Source-paths and destination-paths are separate entities in the list of paths. A destination-path is associated with the source-path that precedes it.
Examples: <snapmirror-file-path>/file1</snapmirror-file-path> will compare the file /file1 on the source with the file with the same path name on the destination <snapmirror-file-path>/file1</snapmirror-file-path> <snapmirror-file-path> @ /dst_file1</snapmirror-file-path> will compare file /file1 on the source with file /dst_file on the destination. If this parameter is specified, parameters source-path, source-snapshot and target-snapshot must also be specified. This parameter is only available on Data ONTAP 8.3 or later.
Outputs
[Family: cluster, vserver]
The snapmirror-check-iter API checks one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
The path to each file to be compared in the target snapshot on the destination volume is the same as the path specified by source-path unless an optional destination-path is specified. Destination-path begins with the @ symbol followed by the path of the file from the root of the target Snapshot copy on the destination volume, e.g. @ /file1 or @ /dira/lun1. Source-paths and destination-paths are separate entities in the list of paths. A destination-path is associated with the source-path that precedes it.
Examples: <snapmirror-file-path>/file1</snapmirror-file-path> will compare the file /file1 on the source with the file with the same path name on the destination <snapmirror-file-path>/file1</snapmirror-file-path> <snapmirror-file-path> @ /dst_file1</snapmirror-file-path> will compare file /file1 on the source with file /dst_file on the destination. If this parameter is specified, parameters source-path, source-snapshot and target-snapshot must also be specified. This parameter is only available on Data ONTAP 8.3 or later.
Outputs
[Family: cluster]
The snapmirror-config-replication-cluster-storage-configuration-get API returns information regarding the configuration of the cluster-wide storage associated with cross-cluster replication of Async Vserver DR configuration data.On Data ONTAP 8.3, Async Vserver DR cannot be enabled simultaneously with metrocluster. For this reason this command will return an error if metrocluster is currently enabled on the cluster.
Inputs
Outputs
[Family: cluster]
The snapmirror-config-replication-cluster-storage-configuration-modify API modifies nformation regarding the configuration of the cluster-wide storage associated with cross-cluster replication of Async Vserver DR configuration data.If input is not provided for a particular value, then the item is not modified in the storage configuration.
On Data ONTAP 8.3, Async Vserver DR cannot be enabled simultaneously with metrocluster. For this reason this command will return an error if metrocluster is currently enabled on the cluster.
Inputs
Outputs
[Family: cluster]
This API returns information regarding the eligibility of aggregates to host configuration replication volumes used for the replication of snapmirror configuration data.Inputs
Outputs
[Family: cluster]
This API returns information regarding the eligibility of aggregates to host configuration replication volumes used for the replication of snapmirror configuration data.Inputs
Outputs
[Family: cluster]
Obtain the results of the SnapMirror config replication status check.Inputs
Outputs
[Family: cluster]
Obtain the results of the SnapMirror config replication status check.Inputs
Outputs
[Family: cluster]
Obtain the results of the SnapMirror config replication status check.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-create API creates a SnapMirror relationship between a source and destination volume or Vserver. The following types of relationships can be created:Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-destroy API removes only the SnapMirror relationship of a source volume and a destination volume, the volumes are not destroyed and Snapshot copies on the volumes are not removed. In case of a Vserver SnapMirror relationship, this API removes only the relationship between a source and destination Vserver. The Vservers are not destroyed. The key parameter that identifies any SnapMirror relationship is the destination volume or the destination Vserver in the case of a Vserver SnapMirror relationship on Data ONTAP 8.3 or later. You must specify the destination endpoint when using snapmirror-destroy. On Data ONTAP 8.1 operating in Cluster-Mode, the snapmirror-destroy API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. On Data ONTAP 8.2 operating in Cluster-Mode, the snapmirror-destroy API will attempt to abort any ongoing transfer. However, failure to abort the transfer will not cause the API to fail. A set of load-sharing mirrors might contain multiple destination volumes, each destination volume having a separate SnapMirror relationship with the common source volume. When used on one of the SnapMirror relationships from the set of load-sharing mirrors, the snapmirror-destroy API deletes the specified SnapMirror relationship from the set of load-sharing mirrors. The snapmirror-destroy API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume or a load-sharing volume that was a destination of a SnapMirror relationship retains its read-only attributes. Note: When a SnapMirror relationship from a set of load-sharing mirrors is deleted, the destination volume becomes a data protection volume and retains the read-only attributes of a data protection volume. On Data ONTAP 8.2 operating in Cluster-Mode, this API can only be issued on the destination Vserver. The SnapMirror relationship information is deleted from destination Vserver, but no cleanup or deletion is performed on the source Vserver. The snapmirror-release API must be issued on the source Vserver to delete the relationship information on the source Vserver. On Data ONTAP 8.1 operating in Cluster-Mode, this API can be issued on the source or on the destination cluster. When issued on the destination cluster, the SnapMirror relationship information on the source and destination clusters is deleted. When issued on the source cluster, only the SnapMirror relationship information on the source cluster is deleted. Note: If the SnapMirror relationship identified by the destination endpoint does not exist, this API will return success. This API is not supported if the destination end point is a Infinite Volume.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-destroy-async API removes the SnapMirror relationship between a source and destination Infinite Volume or a source and destination Vserver. The volumes or Vservers themselves are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy-async. The destination endpoint could be aInputs
Outputs
[Family: cluster, vserver]
Removes one or several SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-get API returns information for a SnapMirror relationship.On Data ONTAP 8.1 operating in Cluster-Mode this API can be issued on the source cluster or destination cluster of the relatonship. On Data ONTAP 8.2 operating in Cluster-Mode, this API must be issued on the destination Vserver or the destination cluster of the relationship. The destination endpoint must be specified when using the snapmirror-get API.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-get-destination API returns information about a SnapMirror relationship whose source endpoint is on the cluster or Vserver it is issued on. The destination endpoint must be specified when using this API. The source endpoint can also be specified.The cluster or Vserver may have several entries for the specified endpoints, but with different relationship IDs. In this case the API returns information about the first entry. To get information about all the SnapMirror relationships matching the specified endpoints, the snapmirror-get-destination-iter API must be used.
Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated.
The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode.
This API must be issued on the source Vserver or the source cluster of the relationship.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-get-destination-iter API returns information about, one or more SnapMirror relationships whose source endpoints are in the Vserver or the cluster the API is issued on.The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver. Stale information may result to several entries being returned with the same source and destination endpoints, but with different relationship IDs.
Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode. It can be issued on a Vserver or a Cluster.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-get-iter API returns information for one or several SnapMirror relationships.On Data ONTAP 8.1 operating in Cluster-Mode, this API can be issued on a cluster. It returns all SnapMirror relationships that have a source or destination endpoint in that cluster, and that match the parameters specified. On Data ONTAP 8.2 operating in Cluster-Mode, this API can be issued on a Vserver or a cluster. It returns all the SnapMirror relationships, which have a destination endpoint in that Vserver or cluster, and that match the parameters specified.
Inputs
Outputs
[Family: cluster]
Obtain the total number of SnapMirror relationships. This is a point in time estimate and may be different on subsequent calls.Inputs
Outputs
[Family: cluster]
Returns SnapMirror status values for a given volume. Including whether: the volume is a source of a SnapMirror relationship; the volume is a destination of a SnapMirror relationship; a transfer is in progress; the relationship is broken off. On Data ONTAP 8.1 operating in Cluster-Mode, this API is provided for backward compatibility only. It will fail if the volume is the source or destination of a load-sharing SnapMirror relationship. It is recommended to use the snapmirror-get-iter API to get the same information. On Data ONTAP 8.1 operating in Cluster-Mode, this API must be issued on the cluster the volume belongs to. This API is not supported On Data ONTAP 8.2 or later operating in Cluster-Mode. You must use the snapmirror-get-iter and snapmirror-get-destination-iter APIs. If issued on Data ONTAP 8.2 or later operating in Cluster-Mode, this API will return EOPNOTSUPPORTED error.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-history-get API returns information for a SnapMirror operation.This API must be issued on the destination Vserver or the destination cluster of the relationship. The operation-id must be specified when using the snapmirror-history-get API. This API can be used only with Data ONTAP 8.3 (or later). The snapmirror-history-get API does not return information about operations which happened while operating prior to Data ONTAP 8.3. The snapmirror-history-get API does not return information for relationships using a control plane compatible with Data ONTAP 8.1. This API does not return information for operations on FlexGroup relationships which happened prior to installing Data ONTAP 9.5. This API does not return information about operations on FlexGroup constituents.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-history-get-iter API returns information for one or several SnapMirror operations. This API must be issued on the destination Vserver or the destination cluster of the relationship. This API can be used only with Data ONTAP 8.3 (or later). It returns all the SnapMirror operations, which have a destination endpoint in that Vserver or cluster, and that match the parameters specified. The snapmirror-history-get API does not return information about operations which happened while operating prior to Data ONTAP 8.3. The snapmirror-history-get API does not return information for relationships using a control plane compatible with Data ONTAP 8.1. This API does not return information for operations on FlexGroup relationships which happened prior to installing Data ONTAP 9.5. This API does not return information about operations on FlexGroup constituents.Inputs
Outputs
[Family: cluster, vserver]
Performs the initial update of a SnapMirror relationship. You must specify the destination endpoint when using snapmirror-initialize. This API must be used from the destination storage system on Data ONTAP operating in 7-Mode, from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and from the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.On Data ONTAP operating in 7-Mode, If the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist.
On Data ONTAP operating in Cluster-Mode, this API is usually used after the snapmirror-create API, but it can be used alone, that is, without the snapmirror-create API, for data protection relationships only, to create and initially update a SnapMirror relationship.
On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode (The relationship-control-plane field is set to 'v1'), a job will be spawned to operate on the SnapMirror relationship, and the job id will be returned. The progress of the job can be tracked using the job APIs.
On Data ONTAP 8.2 or later operating in Cluster-Mode, for extended_data_protection relationships, a 32-bit volume cannot be the source or destination of the relationship.
On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API, except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
On Data ONTAP 8.3 or later result-operation-id is returned. It only contains a valid value if the relationship control plane is ???v2???. A null UUID value (00000000-0000-0000-0000-000000000000) is returned when the field is not valid. This operation-id appears in the current-operation-id field returned by the snapmirror-get API as long as the operation is active.
With Data ONTAP 8.3 or later, this API can be used to initialize a relationship between two volumes or two Vservers. 1. When volume names are specified, this API initializes a volume level relationship. 2. When Vserver names without volume names are specified, this API will initialize a relationship between two Vservers. This API can only be used for relationships between two Vservers after a successful snapmirror-create API. During initialize a baseline transfer of the Vserver is performed.
With Data ONTAP 9.1, this API can be used to initialize a relationship between a Data ONTAP volume and an AltaVault destination. 1. When an AltaVault destination is specified, the source must be a Data ONTAP volume. 2. An AltaVault source cannot be specified for initialize.
With Data ONTAP 9.3, this API can be used to initialize a relationship between a Data ONTAP volume and a SolidFire endpoint.
Inputs
This parameter is mandatory on Data ONTAP operating in 7-mode. This parameter is mandatory if destination-vserver and, for relationships with volumes as endpoints, destination-volume are not specified.
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Vserver level SnapMirror relationships do not support this parameter.
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
[Family: cluster, vserver]
The snapmirror-initialize-iter API initializes the destination volume of one or more SnapMirror relationships. On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode (The relationship-control-plane field is set to 'v1'), A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Vserver level SnapMirror relationships do not support this parameter.
Outputs
[Family: cluster, vserver]
The snapmirror-initialize-ls-set API performs the initial manual update of a set of load-sharing mirrors. This API is usually used after the snapmirror-create API is used to create a SnapMirror relationship for each of the destination volumes in the set of load-sharing mirrors. You must specify the source endpoint when using snapmirror-initialize-ls-set. Data and Snapshot copies are transferred from the source volume to all up-to-date destination volumes in the set of load-sharing mirrors. Use the snapmirror-initialize API to add and initialize a new destination volume to an existing set of load-sharing mirrors. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-modify API changes one or more parameters of a SnapMirror relationship. The key parameter that identifies any SnapMirror relationship is the destination volume or the destination Vserver in the case of a Vserver SnapMirror relationship on Data ONTAP 8.3 or later.You must specify the destination endpoint when using the snapmirror-modify API. For load-sharing mirrors, a change to a parameter affects all of the SnapMirror relationships in the set of load-sharing mirrors. Destination volumes in a set of load-sharing mirrors do not have individual parameter settings. Changes made by the snapmirror-modify API do not take effect until the next manual or scheduled update of the SnapMirror relationship. Changes do not affect updates that have started and have not finished yet. On Data ONTAP 8.1 operating in Cluster-Mode this API must be issued on the destination Cluster. On Data ONTAP 8.2 operating in Cluster-Mode, this API must be issued on the destination Vserver if operating in a Vserver context and on the destination cluster if operating in a cluster context. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-modify-iter API allows to change one or more parameters of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-promote API performs a failover to the destination volume of a load-sharing SnapMirror relationship. This API changes the destination volume from a load-sharing volume to a read-write volume and makes the destination volume assume the identity of the source volume. The API then destroys the original source volume. The destination volume must be a load-sharing volume. However, you can still perform 'snapmirror-promote' on a destination load-sharing volume that has been left in read-write state by a previously failed promote operation. You must specify the destination endpoint when using snapmirror-promote. Note: The source volume and destination volume must be on the same Vserver for the promote to work. Client accesses are redirected from the original source volume to the promoted destination volume. The view clients see on the promoted destination volume is the latest transferred Snapshot copy, which might lag behind the view clients had of the original source volume before the promote. The SnapMirror relationship is usually deleted as part of the promotion process. This is not true for a set of load-sharing mirrors that contain more than one destination volume. In this case, the promoted destination volume becomes the new source volume to the set of load-sharing mirrors. It is possible that the original source volume is the source of multiple SnapMirror relationships. For such a configuration, the promoted destination volume becomes the new source volume of the other SnapMirror relationships. The snapmirror-promote API fails if a SnapMirror transfer is in progress for any SnapMirror relationship involving the original source volume.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-promote-iter API performs failover for one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-protect API protects the specified list of volumes. The snapmirror-protect API must be used from the destination cluster. It is supported for FlexVol and FlexGroup endpoints. It is not supported for FlexGroup constituents, Infinite Volumes, Infinite Volume constituents, Vserver, AltaVault, or SolidFire endpoints. This API is available in Data ONTAP 9.3 and later.On Data ONTAP 9.4 and later, this API supports protecting FlexGroup endpoints. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: cluster, vserver]
Disables future transfers to a SnapMirror destination. If there is no transfer in progress, the SnapMirror relationship becomes 'Quiesced'. If there is a transfer in progress, the SnapMirror relationship becomes 'Quiescing' until the transfer completes. If the current transfer aborts, it will be treated like a future transfer and will not restart. When a SnapMirror relationship is quiesced, it remains in that state across reboots and fail-overs. The relationship must exist on the destination and you must specify the destination endpoint when using snapmirror-quiesce. The destination end point could be a:Inputs
Outputs
[Family: cluster, vserver]
Disables future transfers for one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-release API removes a SnapMirror relationship on the source endpoint. It unlocks and cleanups the snapshots pertaining to the relationship. It does not destroy any volume. You must specify the destination endpoint when using snapmirror-release. The destination end-point could be a: (a) Volume for a volume level relationship (b) Vserver for a Vserver SnapMirror relationship on Data ONTAP 8.3 or later. Unless relationship-info-only is specified, this operation will fail if it is unable to reach the source volume and clean up snapshots. On Data ONTAP 8.3 or later, if operated on a Vserver SnapMirror relationship, relationships will be removed for all the volumes belonging to the Vserver. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be executed on the source Vserver or source cluster following the deletion of the relationship on the destination Vserver or destination cluster. It is possible to issue snapmirror-release on the source Vserver without deleting the relationship on the destination Vserver. However, the relationship will continue to exist because the destination is the authority. The relationship will reappear on the source on the next transfer. On Data ONTAP operating in 7-Mode, this API must be issued on the source storage system. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be issued on the source Vserver if operating in Vserver context and on the source cluster if operating in a cluster context. This API is not supported on Data ONTAP 8.1 operating in Cluster-Mode, or Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'. This API is not supported for relationships with non-Data ONTAP endpoints.Inputs
Outputs
[Family: cluster, vserver]
releases one or a group of SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-restore API restores either the entire contents of a selected Snapshot copy or selected files or LUNs of a selected Snapshot copy from the source volume to the active file system (AFS) of the destination volume.The snapmirror-restore API creates a temporary SnapMirror restore relationship. For this reason the destination volume cannot be the destination volume of another SnapMirror relationship. The temporary restore relationship is deleted after the operation completes successfully.
When restoring the entire contents of a Snapshot copy the following applies.
A read-write destination volume is converted to a data-protection volume for the duration of the operation. When the destination volume is converted to a data-protection volume the latest Snapshot copy on destination volume is made the exported Snapshot copy. Note, that any data written to the destination volume since the last Snapshot copy is lost during this operation. To save the contents of the AFS on the destination volume, stop all client access and create a new Snapshot copy before starting this operation.
During an incremental restore a common Snapshot copy is selected. The Snapshot copy chosen as the common Snapshot copy must be on the source and destination volumes. The contents of the common Snapshot copy on the destination volume are copied to the AFS of the destination volume. Then the contents of the Snapshot copy to be restored are transferred from the source volume to the destination volume.
The destination volume is converted to a read-write volume after the contents of the Snapshot copy have been transferred to the AFS of the destination volume.
If the destination volume is not an empty data protection volume or a read-write volume with at least one Snapshot copy which also appears on the source volume, the command fails.
Unless 'source-snapshot' is specified the most recent Snapshot copy on the source volume is restored.
When restoring a list of files or LUNs of a Snapshot copy the following applies.
The destination volume must be a read-write volume and the state of the volume is not changed by the restore operation.
Use the 'file-list' parameter to indicate the files or LUNs to be restored. Access to the files or LUNs being restored on the destination volume is restricted during the operation.
If the file or LUN to which data is to be restored does not exist in the destination volume's AFS it will be created. When creating a file or LUN in the destination AFS, all directories in the path of the file or LUN being restored must exist and for a LUN the parent directory must also be the root of the destination volume or the root of a Qtree in the destination volume.
The 'source-snapshot' parameter is required when restoring a list of files or LUNs. Files or LUNs to be restored must exist in the source Snapshot copy.
If the file or LUN being restored exists in the destination volume's AFS but is not the same file or LUN as in the source Snapshot copy, the contents of the file or LUN in the destination volume AFS will be overwritten but the file or LUN will retain its inode and for a LUN its identity as well. If the file or LUN being restored exists in the destination volume AFS it must be the same type as the file or LUN in the source Snapshot copy. Overwriting a file with a LUN or LUN with a file is not supported.
The 'create-check-snapshot' parameter is supported only when restoring files or LUNs and should be used only if the contents of the files or LUNs restored are to be verified using the 'snapmirror-check' API.
This API may be used to restart a failed snapmirror-restore operation.
This API may be used to terminate an aborted or failed snapmirror-restore operation by specifying the 'clean-up-failure' parameter set to 'true'. Terminating an aborted or failed snapmirror-restore operation deletes any residual temporary restore relationship.
Terminating an operation restoring the entire contents of a Snapshot copy converts the destination volume back to being read-write if the destination volume was read-write prior to the initial snapmirror-restore operation while removing any data transferred or copied during the snapmirror-restore operation.
On Data ONTAP 9.1, only the SnapMirror source can be an AltaVault endpoint and the destination must be a Data ONTAP volume.
On Data ONTAP 9.4 and later, this API supports FlexGroup endpoints.
Terminating an operation restoring files or LUNs of a Snapshot copy deletes any files whose contents were partially restored but does not delete partially restored LUNs. Access restriction to the partially restored LUNs is not removed. Such a LUN may be deleted using the 'lun-destroy' API with the 'destroy-fenced-lun' parameter. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: cluster, vserver]
Enables future transfers for a SnapMirror relationship that has been quiesced. If there is a scheduled transfer, it will be triggered on the next schedule. If there is a restart checkpoint, it will be re-used if possible. On Data ONTAP Cluster-Mode, If applied on a load-sharing SnapMirror relationship, transfers will resume for all the relationships of the set. With Data ONTAP 8.3 or later, if executed on a Vserver SnapMirror relationship, transfers will resume for all the volumes belonging to the Vserver. When a quiesced SnapMirror relationship is resumed, it remains in that state across reboots and fail-overs. The relationship must exist on the destination and you must specify the destination end point when using snapmirror-resume. The destination end-point could be a: (a) Volume for a volume level relationship (b) Vserver for a Vserver SnapMirror relationship on Data ONTAP 8.3 or later. (c) Non-Data ONTAP destination on Data ONTAP 9.1 or later. This API must be issued on the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.Inputs
Outputs
[Family: cluster, vserver]
Enables future transfers for one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
Re-establishes a mirroring relationship betweenOn Data ONTAP operating in Cluster-Mode this API is usually used on existing SnapMirror relationships, but it can be used, for data protection relationships only, to create a SnapMirror relationship in addition to performing the resync operation.
Typically, the snapmirror-resync API is executed in the following cases:
The default behavior of the snapmirror-resync API is defined as follows:
On Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode, a job is spawned to operate for the SnapMirror relationship and the job id is returned. The progress of the operation can be tracked using the job APIs.
On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
On Data ONTAP 8.3 or later result-operation-id is returned. It only contains a valid value if the relationship control plane is ???v2???. A null UUID value (00000000-0000-0000-0000-000000000000) is returned when the field is not valid. This operation-id appears in the current-operation-id field returned by the snapmirror-get API as long as the operation is active.
On Data ONTAP operating in 7-Mode, the update is asynchronously handled, and there is no guarantee that it succeeds. This requires that a schedule in /etc/snapmirror.conf is set for the destination.
The API must be issued on the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.
With Data ONTAP 9.1, this API can be used to resync a Data ONTAP source volume and an AltaVault destination. 1. When an AltaVault destination is specified, the source must be a Data ONTAP volume. 2. An AltaVault source cannot be specifed for resync.
With Data ONTAP 9.3, this API can be used to resync a Data ONTAP volume and a SolidFire endpoint. 1. When a SolidFire endpoint is specified, the other side of the SnapMirror relationship must be a Data ONTAP volume.
Inputs
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode and for extended data protection relationships with policy type as vault or mirror-vault.
This parameter is not supported for relationships with non-Data ONTAP endpoints.
This parameter is not supported for data protection and load-sharing relationships.
This parameter only applies on Data ONTAP 8.3 or later.
This parameter is not supported for relationships with non-Data ONTAP endpoints.
For data protection mirror relationships and extended data protection relationships with policy type async-mirror, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred.
For extended data protection relationships with policy type vault or mirror-vault, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It transfers the specified Snapshot copy instead of the ones that match its policy's rules.
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
[Family: cluster, vserver]
The snapmirror-resync-iter API establishes or reestablishes one or more SnapMirror relationships between a source and a destination endpoint. This API is not supported on Infinite Volume constituents. On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode (The relationship-control-plane field is set to 'v1'), A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode and for extended data protection relationships with policy type as vault or mirror-vault.
For data protection mirror relationships and extended data protection relationships with policy type async-mirror, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred.
For extended data protection relationships with policy type vault or mirror-vault, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It transfers the specified Snapshot copy instead of the ones that match its policy's rules.
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
[Family: vserver]
Add an owner to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: vserver]
Delete an owner used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: cluster, vserver]
List all owners used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: cluster, vserver]
List all Snapshot copies that are preserved for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: cluster, vserver]
Updates the destination endpoint of the SnapMirror relationship. The update is asynchronously handled, and there is no guarantee that it will succeed.On Data ONTAP operating in 7-Mode the snapmirror-get-status API can be used to check the status of the update. The API must be issued on the destination storage system.
On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode and for relationships using a control plane compatible with Data 8.1 operating Cluster-Mode (relationship-control-plane set 'v1'), a job will be spawned to operate on the SnapMirror relationship, and the job id will be returned. The progress of the job can be tracked using the job APIs.
On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API, except for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode.
On Data ONTAP 8.3 or later result-operation-id is returned. It only contains a valid value if the relationship control plane is ???v2???. A null UUID value (00000000-0000-0000-0000-000000000000) is returned when the field is not valid. This operation-id appears in the current-operation-id field returned by the snapmirror-get API as long as the operation is active.
With Data ONTAP 8.3 or later, this API can be used to update a relationship between two volumes or two Vservers. 1. When volume names are specified, this API updates a volume level relationship. 2. When Vserver names without volume names are specified, this API will update a relationship between two Vservers.
With Data ONTAP 9.1, this API can be used to update a relationship between a Data ONTAP source volume and an AltaVault destination endpoint. 1. When an AltaVault destination is specified, the source must be a Data ONTAP volume. 2. An AltaVault source cannot be specifed for update.
With Data ONTAP 9.3, this API can be used to update a relationship between a Data ONTAP volume and a SolidFire endpoint. 1. When a SolidFire endpoint is specified, the other side of the SnapMirror relationship must be a Data ONTAP volume.
You must specify the destination endpoint when using snapmirror-update.
The API makes the destination endpoint or non-Data ONTAP destination an up-to-date mirror of the source endpoint.
This API must be used from the destination storage system on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and from the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.
On Data ONTAP operating in 7-Mode, if the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist.
On Data ONTAP Cluster-Mode if the destination volume or non-Data ONTAP endpoint is empty, the snapmirror-update API will fail. The snapmirror-initialize API must be called to perform the baseline transfer before the snapmirror-update can be called.
For data protection relationships, the snapmirror-update API makes the destination volume an up-to-date mirror of the source volume with the following steps:
For extended data protection relationships with policy type vault, the snapmirror-update API does not take a Snapshot copy on the source volume. For extended data protection relationships with policy type as mirror-vault, the snapmirror-update API takes a Snapshot copy on the source volume. But both of them transfer only selected Snapshot copies that are newer than the common Snapshot copy to the destination volume. Snapshot copies are selected by matching their 'snapmirror-label' with the 'snapmirror-label' of one of the rules from the corresponding SnapMirror policy associated with the SnapMirror relationship. All matching Snapshot copies are incrementally transferred to the destination volume.
For extended data protection relationships with policy type as vault or mirror-vault, the snapmirror-update API also manages expiration of Snapshot copies on the destination volume. It does so by deleting Snapshot copies that have exceeded the value of 'keep' for the matching rule from the corresponding SnapMirror policy associated with the SnapMirror relationship. Snapshot copies that match the same 'snapmirror-label' will be deleted in oldest-first order.
For data protection relationships, the parameter 'source-snapshot' is optional and allows for the transfer of Snapshot copies newer than the common Snapshot copy up to the specified 'source-snapshot'.
For extended data protection relationships, the parameter 'source-snapshot' is optional and allows transfer of a Snapshot copy that is older than the common Snapshot copy and/or may not be selected for transfer based on policy-based selection of an update transfer.
After the snapmirror-update API successfully completes, the last Snapshot copy transferred is made the new exported Snapshot copy on the destination volume. If an update to an extended data protection relationship specifies a Snapshot copy using the 'source-snapshot' parameter that is older than the common snapshot, after the snapmirror-update API successfully completes, the exported Snapshot copy on the destination volume will remain unchanged.
If the snapmirror-update does not finish successfully, due to a network failure or because a snapmirror-abort API was issued for example, a restart checkpoint might be recorded on the destination volume. If a restart checkpoint is recorded, the next update restarts and continues the transfer from the restart checkpoint. For extended data protection relationships, the next update will restart and continue the old transfer regardless of whether it is a matching Snapshot copy or not.
On Data ONTAP 8.1 operating in Cluster-Mode, you can use the snapmirror-update API to update a specific load-sharing mirror that lags behind up-to-date destination volumes in the set of load-sharing mirrors. An update to the lagging load-sharing mirror should bring it up to date with the other up-to-date destination volumes in the set of load-sharing mirrors. Note: You might have to run the snapmirror-update API more than once if the command does not finish before the next scheduled update of the set of load-sharing mirrors.
Inputs
The transfer fails if it cannot be done storage efficiently. If the transfer succeeds, storage efficiency will be enabled on this extended data protection relationship and all future transfers will continue to be storage efficient for as long as possible, but will not fail should those transfers not be storage efficient.
The default value for this parameter is false. Note that a false value for this parameter only means that storage efficiency will not attempt to be switched on. If storage efficiency is currently enabled, providing this value as false will not disable storage efficiency.
This paramter is not supported for relationships with non-Data ONTAP endpoints.
For a qtree relationship, Data ONTAP 7-mode does not create a new Snapshot copy and transfers the specified Snapshot copy instead.
For data protection relationships and extended data protection relationships with policy type async-mirror, Data ONTAP Cluster-Mode does not create a new Snapshot copy. Depending on the specific policy attached, it will either transfer only the specified Snapshot copy, or it will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred.
For extended data protection relationships with policy type vault or mirror-vault, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It just transfers the specified Snapshot copy instead of the ones that match its policy's rules.
Vserver level SnapMirror relationships do not support this parameter.
This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
[Family: cluster, vserver]
The snapmirror-update-iter API updates the destination volumes of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents. On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode (The relationship-control-plane field is set to 'v1'), A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
The transfer fails if it cannot be done storage efficiently. If the transfer succeeds, storage efficiency will be enabled on this vault relationship and all future transfers will continue to be storage efficient for as long as possible, but will not fail should those transfers not be storage efficient.
The default value for this parameter is false. Note that a false value for this parameter only means that storage efficiency will not attempt to be switched on. If storage efficiency is currently enabled, providing this value as false will not disable storage efficiency.
For a qtree relationship, Data ONTAP 7-mode does not create a new Snapshot copy and transfers the specified Snapshot copy instead.
For data protection relationships and extended data protection relationships with policy type async-mirror, Data ONTAP Cluster-Mode does not create a new Snapshot copy. Depending on the specific policy attached, it will either transfer only the specified Snapshot copy, or it will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred.
For extended data protection relationships with policy type vault or mirror-vault, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It just transfers the specified Snapshot copy instead of the ones that match its policy's rules.
Vserver level SnapMirror relationships do not support this parameter.
Outputs
[Family: cluster, vserver]
The snapmirror-update-ls-set API updates destination volumes of the set of load-sharing mirrors. The API makes destination volumes, in the group of load-sharing mirrors, up-to-date mirrors of the source volume. You must specify the source endpoint when using snapmirror-update-ls-set. Separate SnapMirror transfers are performed from the source volume to each of the up-to-date destination volumes in the set of load-sharing mirrors. Load-sharing mirrors that lag behind the up-to-date destination volumes might not be updated by the snapmirror-update-ls-set API. Use the snapmirror-update API to update a lagging load-sharing mirror. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Add a rule to SnapMirror policyInputs
Outputs
[Family: vserver]
Create the specified SnapMirror PolicyInputs
Outputs
[Family: vserver]
Delete the specified SnapMirror PolicyInputs
Outputs
[Family: vserver]
Get Information about a single SnapMirror PolicyInputs
Outputs
[Family: cluster, vserver]
Get Information about multiple SnapMirror PoliciesInputs
Outputs
[Family: vserver]
Modify the specified SnapMirror PolicyInputs
Outputs
[Family: vserver]
Modify a SnapMirror policy ruleInputs
Outputs
[Family: vserver]
Remove a rule from SnapMirror policyInputs
Outputs
[Family: vserver]
Returns the current snapshot autodelete settings.Inputs
Outputs
[Family: vserver]
Set the option named 'option-name' to the value specified by 'option-value' in the autodelete settings of the specified volume.This API is not supported on FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Create a new snapshot on a specified volume.This API is not supported on Infinite Volume.
Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Create a new snapshot on a specified Infinite Volume.
This API is not supported on flexible volumes, Infinite Volume constituents, and FlexGroups.
Inputs
Outputs
[Family: vserver]
Delete a snapshot on a specified volume. EBUSY is returned when the snapshot is in use. EROFS is returned when the volume is read-only. EAGAIN is returned when splitting a blockmap or reverting.This API is not supported on Infinite Volume.
Inputs
The default value is false.
An example of an actual UUID is:
73a010ec-3d28-11df-84e8-123478563412
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Delete a snapshot on a specified Infinite Volume. EBUSY is returned when the snapshot is in use. EROFS is returned when the Infinite Volume is read-only. EAGAIN is returned when splitting a blockmap or reverting.
This API is not supported on flexible volumes, Infinite Volume constituents, and FlexGroups.
Inputs
Outputs
[Family: vserver]
Returns the amount of space consumed between two snapshots or a snapshot and active filesystem.This API is not supported on FlexGroups.
Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of snapshot objects.Inputs
Outputs
[Family: vserver]
Obtain the current snapshot reserve on a specified volume. Error Returns: Invalid volume name.Inputs
Outputs
[Family: vserver]
Obtain the current snapshot schedule on a specified volume.This API is not the preferred way of obtaining snapshot schedule information in Clustered Data ONTAP. Snapshot schedule information for a given volume may be obtained in Clustered Data ONTAP by using the following steps:
This API is not supported on FlexGroups.
Inputs
Outputs
[Family: vserver]
Return snapshot information for a specified volume. A list of snapshots and information about each snapshot is returned. In Data ONTAP Cluster-Mode, 'snapshot-get-iter' API is the preferred way of retrieving snapshot information.This API is not supported on FlexGroups.
Inputs
Outputs
[Family: cluster, vserver]
Modify the attributes of snapshot or a group of snapshot objects.Inputs
Outputs
[Family: vserver]
Modifies snaplock expiry time of a snapshot copy. Expiry time can only be extended from existing expiry time.Inputs
Outputs
[Family: vserver]
Create a snapshot with the specific name, on each of the specified volumes. It is the caller's responsibility to ensure that the data in the snapshots across all volumes is consistent, by quiescing I/O to these volumes (or the LUNs or NVMe namespaces of interest in these volumes), across the call to this API. The API returns SUCCESS when a snapshot is successfully created on each of the specified volumes. This API bails out and reports FAILURE when an error is found at creating a snapshot on a volume. It does not continue on to create snapshots on the remaining volumes. When the API fails, the returned error code is for the failed volume. For clustered systems, the output 'status' will be set to FALSE in case of failure. In such case the caller should look at the output 'volume-errors' to find out in which volume snapshot creation failed. When an error occurs, it is possible that some snapshots may have been created. If the option cleanup is set to TRUE (default), API will attempt to delete these snapshots (but snapshot deletion may fail). When set to FALSE, it is users' responsibility to delete them. The output array volume-snapcreated-list records for each volume, if a snapshot has been created or not. There are at least two expected use cases for this API. The first one is to call this API with the cleanup option set to TRUE (default). If the call fails, any successfully created snapshots will be deleted before the function returns. This is a simple use case, but has the downside that in case of a failure, the call may take a long time to return due to snapshot cleanup. Another use case would be to call this API in a time critical environment. In such a scenario, it would be good to reduce the impact due to a failure. Hence, it would be better to first call the snapshot-multicreate-validate ZAPI, which would reduce the likelihood of failure of the snapshot-multicreate API. In case a failure does occur, the caller could avoid the cleanup delay by setting the cleanup option to FALSE, and performing snapshot cleanup later, outside the time-critical window.This API is not supported on FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
This is a companion API of snapshot-multicreate. It validates the snapshot creation operation on the specified volumes. But it does not actually create any snapshot. This API only does validations on all volumes and report all errors in the output array. This API is intended to be issued before the snapshot-multicreate API to find out all the errors that may be found during the snapshot create. Its main purpose is to enable snapshot-multicreate's caller to reduce the likelihood of snapshot-multicreate's failure, thereby attempting to avoid the cleanup overhead (of deleting any newly created snapshots) during failure processing. However, this validation API does not guarantee that snapshot-multicreate API will actually work. Something could change between the two calls to cause the actual snapshot creations to fail.This API is not supported on FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Delete the snapshot from the given flexible volumes. This API will return failure if the volume could not be found or it is busy. All the volumes should be online when this API is invoked. It will only delete snapshots on Read-Write volumes. Once all the necessary information to delete snapshots is available, this API will start deleting snapshots on the volumes. If any of the snapshot delete failed, the API will remember the failed volume and continue deleting snapshot on the remaining volumes. In case of failure to delete the snapshots from all the given volumes, the API will return a SUCCESS and also return information about the failed snapshot deletes via the 'volume-errors' output. If the API returns SUCCESS, the applications should check if the 'volume-errors' output is returned or not to check for failed snapshot deletions.This API is not supported on FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Rename Snapshot copies with a specific name to a new name across multiple volumes. The API processes all the specified volumes even if rename fails on one or more volumes. The snapshot-multirename-errors field should be inspected for failures even if the API is successful.This API is not supported on FlexGroups or Infinite Volumes.Inputs
Outputs
[Family: vserver]
Restores a particular range of bytes in a file from a specified snapshot.Partial file restores are used to restore particular pieces of LUNs, NVMe namespace and NFS or CIFS container files that are used by a host to store multiple sources of data. For example, a host may be storing multiple user databases in the same LUN. A partial file restore can be used to restore one of those databases in the LUN while not touching the other databases that are also stored in the LUN. Compressed files will not be restored, though compression may be enabled on the volume.
Partial file restores require significant management by the caller. The caller must understand the metadata of the host LUN, NVMe namespace or container file so that they can know which bytes belong to the object being restored.
Partial file restore is supported only between LUNs or NVMe namespaces with equal block sizes and is supported from source LUN to destination NVMe namespace and from source NVMe namespace to destination LUN.
Before the restore operation begins, the caller must quiesce the object being restored. It must remain quiesced for the duration of the restore operation. No host I/O should be issued for the object while it is being restored because the snapshot-partial-restore-file commands will be incrementally restoring the file, LUN, or NVMe namespace and the host will therefore see inconsistent content for the object until the restore operation is completed. Host I/O is permitted for the other objects stored in the LUN, NVMe namespace or container file because the partial file restore will not touch the bytes belonging to those other objects.
During the restore the caller must issue a snapshot-partial-restore-file command for each of the byte ranges that belong to the object being restored, based on the metadata of the LUN, NVMe namespace or container file. Once each command returns, that byte range is restored and the changes are persistent. If the filer should halt while processing a command, that byte range of the LUN, NVMe namespace or container file is inconsistent. Some of the bytes at the beginning of the range may have been restored while bytes at the end of the range have not been restored. Once the filer is rebooted the caller should re-issue the command to restore that byte range to complete the restore.
Once the restore is completed, the caller must purge any host operating system or application buffers that may hold data for the file, LUN, or NVMe namespace that is now stale. For NFS or CIFS mounted volumes the easiest way to purge any host buffers is to unmount and remount the volume. Applications holding buffered data may need to be shut down and restarted.
Multiple partial file restore requests may be issued to the same file, LUN, or NVMe namespace simultaneously. There is no requirement that the requests are all restoring from the same snapshot so that multiple restore operations for different objects may be concurrent on the same file. There is no checking to prevent overlapping byte ranges between requests. Preventing this condition is the responsibility of the caller.
Partial file restores are not intended for restoring parts of normal user-level files that are stored in an NFS or CIFS exported volume. Use snapshot-restore-file to restore normal files like these.
The volume where the LUN, NVMe namespace or container file to restore and where the snapshot to restore from live must be online and must not be a mirror volume.
The partial file restore request may fail if there is not sufficient free space to overwrite all of the blocks in the byte range to be restored.
The partial file restore request is synchronous, meaning that the command will not return until the entire byte range is restored. The snapshot being restored from cannot be deleted while a request is being executed, but it can be deleted between requests. If this happens the next request will notice that the snapshot has been deleted and will return an error.
The maximum number of bytes of data that can be restored in a single request is given by the max-byte-count value returned by the snapshot-partial-restore-file-list-info command. This limit ensures that requests are periodically interruptible and avoids overloading the filer.
If the system halts while a partial file restore request is being executed, the request will not be restarted upon reboot. Some of the bytes at the beginning of the range may have been restored while bytes at the end of the range have not been restored. The caller should reissue the partial file restore request for that byte range to complete the restore.
This API is not supported on FlexGroups.
Inputs
Outputs
[Family: vserver]
Returns partial file restore settings of the vserver.This API is not supported on FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: cluster, vserver]
Add a new schedule to the Snapshot Policy. A schedule can be created by using 'job-schedule-cron-create' or 'job-schedule-interval-create' APIs.Inputs
Outputs
[Family: cluster, vserver]
This API creates a Snapshot policy and adds the schedules to it. A Snapshot policy includes at least one schedule, up to a maximum of 5 schedules, and a maximum number of Snapshot copies per schedule. A schedule can be created by using 'job-schedule-cron-create' or 'job-schedule-interval-create' APIs. When applied to a volume, the Snapshot policy specifies the schedule on which Snapshot copies are taken and the maximum number of Snapshot copies that each schedule can take. The total count of all the Snapshot copies to be retained for the policy cannot be more than 1023.Inputs
Outputs
[Family: cluster, vserver]
Delete the specified Snapshot Scheduling PolicyInputs
Outputs
[Family: cluster, vserver]
Get Information about a single Snapshot PolicyInputs
Outputs
[Family: cluster, vserver]
Get Information about multiple Snapshot PoliciesInputs
Outputs
[Family: cluster, vserver]
Enable or Disable the specified Snapshot Scheduling PolicyInputs
Outputs
[Family: cluster, vserver]
Modify a snapshot policyInputs
Outputs
[Family: cluster, vserver]
Remove a snapshot schedule from policyInputs
Outputs
[Family: vserver]
Returns the amount of space that would be freed when a set of snapshots are deleted from a specified volume.This API is not supported on FlexGroups.
Inputs
Outputs
[Family: vserver]
Rename a specified snapshot to a new name on a specified volume. This API is not supported on FlexGroups or Infinite Volume constituents.Inputs
Outputs
[Family: cluster, vserver]
Gets the percentage of disk space that is reserved for snapshots in the indicated volume. If no volume is specified, this will return the percentage of disk space reserved for snapshots for each of the volumes in the system. Reserve space can be used only by snapshots and not by the active file system. This API is deprecated in Data ONTAP Cluster-Mode 8.2 and later. Use volume-get-iter instead.Inputs
Outputs
[Family: vserver]
Restores a single file, LUN, or NVMe namespace from the specified snapshot. This operation can be executed to overwrite an existing version of the file, LUN, or NVMe namespace present in the active file system or create a new copy of the file, LUN, or NVMe namespace at a separate location within the same volume. Only normal files, LUNs, and NVMe namespaces are restored. Special files and directories (and their contents) are not restored. Starting Data ONTAP 9.0, restore operation is supported on file with streams. The file, LUN, or NVMe namespace is ready for read/write access once this API returns.This API is not supported on FlexGroups.
Inputs
Outputs
[Family: vserver]
Get information about snapshot file restores on a given vserver. Returns maximum snapshot file restores limit and snapshot file restores in progress numbers.This API is not supported on FlexGroups.
Inputs
Outputs
[Family: vserver]
Reverts a volume to a specified snapshot. The volume must be online and must not be a mirror. If reverting the root volume, the filer will be rebooted. Non-root volumes do not require a reboot. A volume cannot have both a volume snaprestore and a single-file snaprestore executing simultaneously. Multiple single-file snaprestores can be in progress simultaneously. After the reversion, the volume is in the same state as it was when the snapshot was taken.This API is not supported on Infinite Volume.
Inputs
The default value is false.
The default value is false.
An example of an actual UUID is:
84a010ec-3d28-11df-84e8-123478653412
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.5.0.Reverts an Infinite Volume to a specified snapshot. The Infinite Volume must be online and unmounted and must not be a mirror. After the reversion, the Infinite Volume is in the same state as it was when the snapshot was taken.
This API is not supported on flexible volumes, Infinite Volume constituents, and FlexGroups.
Inputs
Outputs
[Family: vserver]
Sets the size of the indicated volume's snapshot reserve to the specified percentage. Reserve space can be used only by snapshots and not by the active file system.Inputs
Outputs
[Family: vserver]
Returns snapshot related volume information. The information returned is valid at the time the API call reached the filer and maybe outdated soon after.This API is not supported on FlexGroups.
Inputs
Outputs
[Family: cluster, vserver]
Adds a community to the list of communities.Inputs
Outputs
[Family: cluster, vserver]
Deletes a community from the list of communities.Inputs
Outputs
[Family: cluster, vserver]
Deletes all the communities.Inputs
Outputs
[Family: cluster]
Disables snmp protocol.Inputs
Outputs
[Family: cluster]
Enables snmp protocol.Inputs
Outputs
[Family: cluster]
Enable SNMPv3 cluster-wideInputs
Outputs
[Family: cluster]
Retrieves the value of a snmp object.Inputs
Outputs
[Family: cluster]
This is used to retrieve the next OID in the mib tree of data. Instead of returning the data you requested, it returns the next OID in the tree and its value. Unlike the snmp-get api, this api does return data for a OID which is too short or is missing the index part of the OID.Inputs
Outputs
[Family: cluster]
Returns configuration information of the SNMP agent daemon.Inputs
Outputs
[Family: cluster]
Trigger SNMP test trapInputs
Outputs
[Family: cluster]
Disables snmp traps.Inputs
Outputs
[Family: cluster]
Enables snmp traps.Inputs
Outputs
[Family: cluster]
Adds a host to the list of trap hosts.Inputs
Outputs
[Family: cluster]
Deletes a host from the list of trap hosts.Inputs
Outputs
[Family: cluster]
return the firmware file listInputs
Outputs
[Family: cluster]
Enables specified host adapter. I/O traffic can be issued on the adapter.Inputs
Outputs
[Family: cluster]
Display the information about a specified host adapter. The information is displayed base on the controller interface type. ATA, Parallel SCSI, SAS, FC.Inputs
Outputs
[Family: cluster]
Get the list of adapters present on this system.Inputs
Outputs
[Family: cluster]
Modify the adapter state.Inputs
Outputs
[Family: cluster]
Generates a high level summary of array LUN pathing (connectivity) information.Inputs
Outputs
[Family: cluster]
Retrieves a list of all array profiles known to the controller.Inputs
Outputs
[Family: cluster]
Update an array profile with new or changed information.Inputs
Outputs
[Family: cluster]
Update an array port with new or changed information.Inputs
Outputs
[Family: cluster]
generate a list of online array ports and their associated arraysInputs
Outputs
[Family: cluster]
Rename an array profileInputs
Outputs
[Family: cluster]
Retrieve the dumpconfiguration file from the bridge.Inputs
Outputs
[Family: cluster]
Delete a saved dumpconfiguration file.Inputs
Outputs
[Family: cluster]
Get a list of available bridge dumpconfiguration files.Inputs
Outputs
[Family: cluster]
Collect the coredump file from the bridge.Inputs
Outputs
[Family: cluster]
Delete a saved coredump fileInputs
Outputs
[Family: cluster]
Return a list of coredumps available.Inputs
Outputs
[Family: cluster]
Download firmware to the specified bridge. The bridge needs to be rebooted for the firmware to be updated successfully.Inputs
Outputs
[Family: cluster]
Get the attributes of the storage-bridge.Inputs
Outputs
[Family: cluster]
Iterate over a list of storage-bridge objects.Inputs
Outputs
[Family: cluster]
Disk enumeration ZAPI. Get disk information about one or more disks, from the Storage Subsystem. Clustered ONTAP iterator APIs support filtering of output, to constrain the disks that are included in the return list, and/or what information is returned about each disk. The default is to return all information about all disks in the cluster. That list may be reduced using the 'query' input element. For example, the return list may include only (1) Disks visible to a particular cluster node "nodeA", e.g., "query.storage-disk-info.disk-paths.disk-path-info.disk-name=nodeA:*" (2) A particular disk visible to a particular node, e.g., "query.storage-disk-info.disk-paths.disk-path-info.disk-name=nodeA:6a.01". (3) A disk with a particular unique id, e.g., "query.storage-disk-info.disk-uid=20000000:87A9652B:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000" (4) Disks with a name that matches a certain wildcard pattern, e.g., "query.storage-disk-info.disk-name=1.*" or "query.storage-disk-info.disk-name=NET-1.*" for virtual disks. (5) Disks assigned to a particular node. e.g., "query.storage-disk-info.disk-ownership-info.home-node-id=1252487" or "query.storage-disk-info.disk-ownership-info.home-node-name=nodeA". (6) Some subset of disks in the cluster or visible to a particular node in the cluster. If 'desired-attributes' is included, then only those data specified by in 'desired-attributes' are returned for each disk. If there is badly formed input or an invalid input value is specified, then EINVALIDINPUTERROR is returned. If there is some internal error which prevents processing of this request, then EINTERNALERROR is returned.Inputs
Outputs
[Family: cluster]
Modify the attributes of storage-disk object.Inputs
Outputs
[Family: cluster]
Sets or Unsets an array LUN as foreignInputs
Outputs
[Family: cluster]
return the firmware file listInputs
Outputs
[Family: cluster]
Balances primary/secondary array LUN paths across available initiator ports based on I/O load. This API is deprecated in Clustered Data ONTAP 8.3.0 and later.Inputs
Outputs
[Family: cluster]
Returns path information and statistics for a given disk or all disks. We use the word disk to refer to an array lun, real disk, or Solid State Device This API is deprecated in Clustered Data ONTAP 8.3.0 and later.Inputs
Outputs
[Family: cluster]
Lists all known disk/configuration errors associated with an array or shelves acting like array.Inputs
Outputs
[Family: cluster]
Gets disk I/O rates for a given fibre channel initiator port or for all initiator ports if no port is specified. The term disk refers to an array LUN, actual disk, or solid state device. This API is deprecated in Clustered Data ONTAP 8.3.0 and later.Inputs
Outputs
[Family: cluster]
Returns information and statistics on all known paths to back end storage.Inputs
Outputs
[Family: cluster]
Quiesces an array LUN on a path. A quiesced array LUN will not be sent I/O on the specified path.Inputs
Outputs
[Family: cluster]
Resumes I/O to array LUN on a path that was previously quiesced. Resuming I/O to a non-quiesced array LUN is a no-op and not an error.Inputs
Outputs
[Family: cluster]
Add an iSCSI target.Inputs
Outputs
[Family: cluster]
Connect to an iSCSI target.Inputs
Outputs
[Family: cluster]
Disconnect from an iSCSI target.Inputs
Outputs
[Family: cluster]
Iterate over a list of iSCSI targets.Inputs
Outputs
[Family: cluster]
Remove an iSCSI target.Inputs
Outputs
[Family: cluster]
Add disks to a storage pool A job will be spawned to operate on the storage-pool and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
This is a ZAPI used to iterate over a list of aggregates provisioned from storage pool.Inputs
Outputs
[Family: cluster]
This is a ZAPI used to iterate over all available capacities available on each node in the cluster. These available capacities are listed per storage pool on each node.Inputs
Outputs
[Family: cluster]
Create a storage pool. Capacity can be allocated to aggregates from these storage pools using 'aggr-add'.Inputs
Outputs
[Family: cluster]
Delete the specified storage pool. A job will be spawned to operate on the storage-pool and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
This is a ZAPI used to iterate over all disks in storage pool. These disks are listed per Storage PoolInputs
Outputs
[Family: cluster]
This is a ZAPI used to iterate over all the storage pools in the cluster and retrieve attributes of individual storage pool.Inputs
Outputs
[Family: cluster]
Reassign capacity from one node to another node in storage pool A job will be spawned to operate on the storage-pool and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Rename storage poolInputs
Outputs
[Family: cluster]
Disable a storage portInputs
Outputs
[Family: cluster]
Enable a storage portInputs
Outputs
[Family: cluster]
Get information about a specified storage port.Inputs
Outputs
[Family: cluster]
Get information about one or more storage ports.Inputs
Outputs
[Family: cluster]
Rescan a storage portInputs
Outputs
[Family: cluster]
Reset a storage portInputs
Outputs
[Family: cluster]
Reset a device behind a storage portInputs
Outputs
[Family: cluster]
Configure connection.Inputs
Outputs
[Family: cluster]
Start shelf firmware download process to update firmware on disk shelves. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on shelves that do not have the latest firmware revision.Inputs
Outputs
[Family: cluster]
Return the connectivity of the node. A return status of Full-Connectivity means, that the connection is properly configured and fully working. Any other status means that an error is seen.Inputs
Outputs
[Family: cluster]
return the first moduleInputs
Outputs
[Family: cluster]
return the module listInputs
Outputs
[Family: cluster]
Get drawer information about a specified storage shelf drawer.Inputs
Outputs
[Family: cluster]
Get drawer information about one or more storage shelf drawers.Inputs
Outputs
[Family: cluster]
Get phy information about a specified storage shelf drawer phy.Inputs
Outputs
[Family: cluster]
Get phy information about one or more storage shelf drawer phys.Inputs
Outputs
[Family: cluster]
Get a map between bay number and drawer/slot number.Inputs
Outputs
[Family: cluster]
Get a map between bay number and drawer/slot number.Inputs
Outputs
[Family: cluster]
Lists all known errors associated with a storage shelf.Inputs
Outputs
[Family: cluster]
Start shelf firmware download process to update firmware on disk shelves. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on shelves that do not have the latest firmware revision.Inputs
Outputs
[Family: cluster]
Storage shelf firmware update status record.Inputs
Outputs
[Family: cluster]
Storage shelf firmware update status records.Inputs
Outputs
[Family: cluster]
Get shelf information about a specified storage shelf.Inputs
Outputs
[Family: cluster]
Get shelf information about one or more storage shelves.Inputs
Outputs
[Family: cluster]
Get the Location LED status of a shelfInputs
Outputs
[Family: cluster]
Get the Location LED status of one or more shelvesInputs
Outputs
[Family: cluster]
Modify the state of the Location LEDInputs
Outputs
[Family: cluster]
Modify the state of the Location LED of one or more shelvesInputs
Outputs
[Family: cluster]
Get information about one or more storage shelf ports.Inputs
Outputs
[Family: cluster]
Configure connection.Inputs
Outputs
[Family: cluster]
return the firmware file listInputs
Outputs
[Family: cluster]
Get the attributes of the storage-switch.Inputs
Outputs
[Family: cluster]
Iterate over a list of storage-switch objects.Inputs
Outputs
[Family: cluster]
Get the cluster-wide EC QoS settings.Inputs
Outputs
[Family: cluster]
Modify the existing cluster-wide EC QoS settings.Inputs
Outputs
[Family: cluster, vserver]
get elements for specified apisInputs
Outputs
[Family: cluster, vserver]
get list of apis. This returns the names only - to get the parameter info, use system-api-get-elementsInputs
Outputs
[Family: cluster, vserver]
get list and description of typedefsInputs
Outputs
[Family: cluster]
Disable Cache MirrorInputs
Outputs
[Family: cluster]
Enable Cache MirrorInputs
Outputs
[Family: cluster]
Get the attributes of Cache Mirror Settings.Inputs
Outputs
[Family: cluster]
Iterate over a list of Cache Mirror Settings.Inputs
Outputs
[Family: cluster]
Obtain appliance information which includes cpu and backplane information. The output contains the head information in a sysconfig -a command. I/O information is not included. System refers to a node in a cluster.Inputs
Outputs
[Family: cluster, vserver]
Obtain the current ONTAPI major and minor versions.Inputs
Outputs
[Family: cluster]
Obtain the Data ONTAP vendor information.Inputs
Outputs
[Family: cluster, vserver]
Obtain the Data ONTAP version.Inputs
Outputs
[Family: cluster]
Create the hypervisor host config.Inputs
Outputs
[Family: cluster]
Destroy the hypervisor host config.Inputs
Outputs
[Family: cluster]
Get the attributes of the hypervisor host config.Inputs
Outputs
[Family: cluster]
Iterate over the attributes of the hypervisor host config.Inputs
Outputs
[Family: cluster]
Modify the hypervisor host config.Inputs
Outputs
[Family: cluster]
Create the hypervisor snmpv3 config.Inputs
Outputs
[Family: cluster]
Destroy the hypervisor snmpv3 config.Inputs
Outputs
[Family: cluster]
Get the attributes of the hypervisor snmpv3 config.Inputs
Outputs
[Family: cluster]
Iterate over the attributes of the hypervisor snmpv3 config.Inputs
Outputs
[Family: cluster]
Modify the hypervisor snmpv3 config.Inputs
Outputs
[Family: cluster]
Create the hypervisor uplink mapping.Inputs
Outputs
[Family: cluster]
Destroy the hypervisor uplink mapping.Inputs
Outputs
[Family: cluster]
Get the attributes of a hypervisor uplink mapping.Inputs
Outputs
[Family: cluster]
Modify the hypervisor uplink mapping.Inputs
Outputs
[Family: cluster]
Delete file on external deviceInputs
Outputs
[Family: cluster]
Display file listing on external deviceInputs
Outputs
[Family: cluster]
Fetch a file from a URL. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.Inputs
Outputs
[Family: cluster]
Display software image informationInputs
Outputs
[Family: cluster]
Perform software image fresh installInputs
Outputs
[Family: cluster]
Modify software image configurationInputs
Outputs
[Family: cluster]
Delete a software packageInputs
Outputs
[Family: cluster]
Display software information for all packagesInputs
Outputs
[Family: cluster]
Perform software image upgrade/downgrade. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.Inputs
Outputs
[Family: cluster]
Abort software image update or get operationInputs
Outputs
[Family: cluster]
Show progress information for current or previous updateInputs
Outputs
[Family: cluster]
Get the discovered nodes sequentially. This returns all unconfigured nodes and all cluster nodes found within the local cluster network.Inputs
Outputs
[Family: cluster]
Obtain the node information when the node is part of a cluster. Information returned includes details like location, serial-number, asset tag, uptime, vendor name etc.Inputs
Outputs
[Family: cluster]
Obtain the node information when the node is a part of the cluster in an iteration.Inputs
Outputs
[Family: cluster]
Modify the node information when the node is a part of the cluster.Inputs
Outputs
[Family: cluster]
Remote Node Power CycleInputs
Outputs
[Family: cluster]
Get power status information about a nodeInputs
Outputs
[Family: cluster]
Remote Node Power OffInputs
Outputs
[Family: cluster]
Remote Node Power OnInputs
Outputs
[Family: cluster]
Reboot the specified node. Only an admin can reboot the node. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.Inputs
Outputs
[Family: cluster]
Rename the specified node to a new name specified by 'new-name'Inputs
Outputs
[Family: cluster]
Reset node using selected BIOS firmwareInputs
Outputs
[Family: cluster]
Shut down a node. Only an admin can initiate a node shutdown. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.Inputs
Outputs
[Family: cluster]
Get the configuration for the web server for Data ONTAP web servicesInputs
Outputs
[Family: cluster]
Get the status of the web server for Data ONTAP web servicesInputs
Outputs
[Family: cluster]
Get the status of the web server for Data ONTAP web servicesInputs
Outputs
[Family: cluster]
Returns the hypervisor support levelsInputs
Outputs
[Family: cluster]
Modifies the hypervisor support levelsInputs
Outputs
[Family: cluster]
Restart a system status serviceInputs
Outputs
[Family: cluster]
Returns status information for objects in the systemInputs
Outputs
[Family: cluster, vserver]
Returns the objects and their operations which are permitted to user who called this API.Inputs
Outputs
[Family: cluster]
Return a tape drive / media changer viewInputs
Outputs
[Family: cluster]
Iterate over the list of Tape/MC objectsInputs
Outputs
[Family: cluster]
Clear tape drive / media changer alias. Specify name or clear-scope but not both.Inputs
Outputs
[Family: cluster]
Set a tape/drive media changer aliasInputs
Outputs
[Family: cluster]
Take a tape drive offline. Specify name or device-id but not both.Inputs
Outputs
[Family: cluster]
Bring a tape drive onlineInputs
Outputs
[Family: cluster]
Position tape cartridgeInputs
Outputs
[Family: cluster]
Reset the tape driveInputs
Outputs
[Family: cluster]
Release a tape drive test reservationInputs
Outputs
[Family: cluster]
Reserve a tape drive for testingInputs
Outputs
[Family: cluster]
Enable/disable tape trace operationsInputs
Outputs
[Family: cluster]
Copy a Template.Inputs
Outputs
[Family: cluster]
Delete a template.Inputs
Outputs
[Family: cluster]
Download a template.Inputs
Outputs
[Family: cluster]
Get the attributes of the template.Inputs
Outputs
[Family: cluster]
Display information about templates.Inputs
Outputs
[Family: cluster]
Get the parameter of a Template.Inputs
Outputs
[Family: cluster]
Get the parameters of the Template.Inputs
Outputs
[Family: cluster]
Modify attributes of a parameter.Inputs
Outputs
[Family: cluster]
Modify attributes of a parameter.Inputs
Outputs
[Family: cluster]
Configures a Vserver according to the specification provided in the template. This is an async operation. On a successful queuing of the import operation, a job ID of the job that would configure the Vserver would be returned.Inputs
Outputs
[Family: cluster]
Get the Template Provision Error Details.Inputs
Outputs
[Family: cluster]
Rename a template.Inputs
Outputs
[Family: cluster]
Upload a template.Inputs
Outputs
[Family: cluster]
Get the attributes of the UC Adapter.Inputs
Outputs
[Family: cluster]
Iterate over a list of UC Adapter objects.Inputs
Outputs
[Family: cluster]
Modify the attributes of UC Adapter object.Inputs
Outputs
[Family: cluster]
Retrieve virtual machine instance information.Inputs
Outputs
[Family: cluster]
Acknowlege that the system is ready for the event to startInputs
Outputs
[Family: cluster]
Retrieve virtual machine instance maintenance event information.Inputs
Outputs
[Family: cluster]
Retrieve virtual machine instance maintenance event information.Inputs
Outputs
[Family: cluster]
Add provider credentials. If the node is already configured with credentials, the command will return EDUPLICATEENTRY.Inputs
Outputs
[Family: cluster]
Remove provider credentials.Inputs
Outputs
[Family: cluster]
Remove provider credentials.Inputs
Outputs
[Family: cluster]
Iterate over a list of provider credentials.Inputs
Outputs
[Family: cluster]
Modify provider credentials. Modifying a node with no existing credentials will succeed in adding the credentials to the node.Inputs
Outputs
[Family: cluster]
Modify provider credentials. Modifying a node with no existing credentials will succeed in adding the credentials to the node.Inputs
Outputs
[Family: cluster]
Add a proxy server. If the node already has a proxy server, the command will return EDUPLICATEENTRY.Inputs
Outputs
[Family: cluster]
Remove a proxy server.Inputs
Outputs
[Family: cluster]
Remove proxy servers.Inputs
Outputs
[Family: cluster]
Iterate over a list of proxy servers.Inputs
Outputs
[Family: cluster]
Modify the proxy server. Modifying a node with no proxy will succeed in configuring a proxy for the node.Inputs
Outputs
[Family: cluster]
Modify the proxy server. Modifying a node with no proxy will succeed in configuring a proxy for the node.Inputs
Outputs
[Family: cluster]
Retrieve Data ONTAP virtual machine system disks details.Inputs
Outputs
[Family: cluster]
Define the configuration for an object store.Inputs
Outputs
[Family: cluster]
Deletes the disk object store.Inputs
Outputs
[Family: cluster]
Add a DNS mapping to the cache.Inputs
Outputs
[Family: cluster]
Delete a DNS mapping from the cache.Inputs
Outputs
[Family: cluster]
Iterate over the list of cached DNS mappings.Inputs
Outputs
[Family: cluster]
Modify a DNS mapping in the cache.Inputs
Outputs
[Family: cluster]
Iterate over the list of object store configurations.Inputs
Outputs
[Family: cluster]
Modify the configuration of an object store.Inputs
Outputs
[Family: cluster]
Retrieve network load balancer information.Inputs
Outputs
[Family: cluster]
Check vSphere credentials by attempting to login to the vSphere server.The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINVALIDINPUTERROR Missing username or password. EAPIAUTHENTICATION vSphere server authentication failed. EHOSTNOTFOUND could not resolve server name with DNS EONTAPI_ECONNREFUSED could not connect to server EINTERNALERROR internal error in underlying implementation
Inputs
Outputs
[Family: cluster]
Reports the currently configured vSphere server and username.The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINTERNALERROR internal error in underlying implementation
Inputs
Outputs
[Family: cluster]
Modify or set initial value for vSphere server, user, and/or password.The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINVALIDINPUTERROR argument(s) too large EINTERNALERROR internal error in underlying implementation
Inputs
Outputs
[Family: cluster]
Infinite Volumes are deprecated and support for them may be removedin a future release of Data ONTAP. If you are using Infinite Volumes it is recommended that youdo not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.Moves all constituents belonging to a given Infinite Volume from the source aggregate to the destination aggregate. A job will be spawned to operate on the volume and the job id will be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Infinite Volumes are deprecated and support for them may be removedin a future release of Data ONTAP. If you are using Infinite Volumes it is recommended that youdo not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.displays information about Auto Balance Volume operations for an Infinite Volume.
This API is only supported for Infinite Volumes.
Inputs
Outputs
[Family: cluster, vserver]
Infinite Volumes are deprecated and support for them may be removedin a future release of Data ONTAP. If you are using Infinite Volumes it is recommended that youdo not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.displays information about Auto Balance Volume operations for an Infinite Volume.
This API is only supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Infinite Volumes are deprecated and support for them may be removedin a future release of Data ONTAP. If you are using Infinite Volumes it is recommended that youdo not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.Start Auto Balance Volume for an Infinite Volume and rebalance the used data capacity in an Infinite Volume after files are created. Auto Balance Volume moves data between data constituents of an Infinite Volume. If the Infinite Volume uses storage services, Auto Balance Volume moves data between data constituents of a storage service in an Infinite Volume. Auto Balance Volume ensures that all data constituents in an Infinite Volume or all data constituents in a storage service of an Infinite Volume have similar amounts of used data capacity.
This API is only supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Infinite Volumes are deprecated and support for them may be removedin a future release of Data ONTAP. If you are using Infinite Volumes it is recommended that youdo not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.Allows the user to stop Auto Balance Volume for an Infinite Volume.
This API is only supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Given the name of a volume, get the autosize settings. This API is not supported for Infinite Volumes.Inputs
Outputs
[Family: vserver]
Given the name of a volume, set the autosize settings. This API is not supported for FlexGroups or Infinite Volumes.Inputs
Outputs
[Family: vserver]
Given the name of a volume, set the autosize settings. This API is not supported for flexible volumes or Infinite Volumes.Inputs
Outputs
[Family: cluster, vserver]
Create a flexible volume that is a clone of a "backing" or "parent" flexible volume. A clone is a volume that is a writable snapshot of another volume. Initially, the clone and its parent share the same storage; more storage space is consumed only as one volume or the other changes. If a specific snapshot name within the parent volume is provided, it is chosen as the parent snapshot. Otherwise, the filer will create a new, distinctively- named snapshot in the parent volume for that purpose. The parent snapshot is locked in the parent volume, preventing its deletion until the clone is either destroyed or split from the parent using the 'volume-clone-split-start' command (see below). This command fails if the chosen parent volume is currently involved in a split operation. This command also fails if the chosen parent volume is a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'.
An example of a valid junction path is: '/user/my_volume'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
Possible values:
Outputs
[Family: vserver]
Display details of a specific FlexClone volumeInputs
Outputs
[Family: cluster, vserver]
Display a list of FlexClone volumesInputs
Outputs
[Family: vserver]
Display an estimate of additional storage required in the underlying aggregate to perform a volume clone split operation. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
Outputs
[Family: vserver]
Begin the process by which the given clone is split off from its underlying parent volume and snapshot. New storage is allocated for the clone that is distinct from its parent. This process may take some time and proceeds in the background. Use the 'volume-clone-split-status' command to view the operation's progress. Both clone and parent volumes remain available during the process of splitting them apart. Upon completion, the snapshot on which the clone was based will be unlocked in the parent volume. Any snapshots in the clone are removed at the end of processing. Use the 'volume-clone-split-stop' command to stop this process. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.In Data ONTAP Cluster-Mode, a job is created to perform the split operation. The job id of the job is returned in the API response. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Display the progress in separating clones from their underlying parent volumes and snapshots. If a clone name is specified, then the split status for that clone is provided. If no clone name is provided, then status is provided for all clones currently being split. This command fails if applied to a traditional volume, and EONTAPI_EVOLNOTFLEX is thrown. Cloning is a capability that applies exclusively to flexible volumes. This command fails if the volume specified is not a clone, and EVOLNOTCLONE is thrown. This command fails if the volume specified is not being split, and EVOLOPNOTUNDERWAY is thrown.Inputs
Outputs
[Family: vserver]
Stop the process of splitting off a clone from its parent volume and snapshot. All of the blocks that were formerly shared between the given clone and its parent volume that have already been split off will remain that way. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
Outputs
[Family: vserver]
Return the name of the containing aggregate for the named flexible volume.Inputs
Outputs
[Family: cluster]
Copy a volume A job will be spawned to operate on the volume and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Create a volume.The detailed behavior of this API depends on where it is received:
1. In Data ONTAP Cluster-Mode, create a new flexible volume.
2. In Data ONTAP 7-Mode, create a new flexible, traditional, or sparse volume with the given name and characteristics. Freshly-created traditional volumes may not be operational immediately after the API returns. Use 'volume-list-info' to obtain information about volumes, including the status of the newly-created traditional volume in order to determine when it is fully operational.
This API is not supported for FlexGroups.
Inputs
If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning Vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
This input is required for creating a Cluster-Mode volume.
This policy can be created using the 'volume-efficiency-policy-create' API.
Possible values:
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API.
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API.
For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data).
It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found.
For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable.
The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's namespace. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'.
An example of a valid junction path is: '/user/my_volume'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.
For 7-Mode volumes, the default setting of 10240 limits directory size to 10 MBytes and allows it to hold up to approximately 300,000 files. For Cluster-Mode volumes, the default setting is 100 MBytes and it allows the directory to hold up to approximately 3,000,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
This feature is deprecated.
The default policy name is 'default'.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
none: The value of none does not provide any guarantee for overwrites or enforce any restrictions. It should be used if the admin plans to manually manage space consumption in the volume and aggregate, and out of space errors.
thick: The value of thick guarantees that the hole fills and overwrites to space-reserved files in this volume will always succeed by reserving space. To meet this space SLO, the following volume-level settings are automatically set and cannot be modified:
semi-thick: The value of semi-thick is a best-effort attempt to ensure that overwrites succeed by restricting the use of features that share blocks and auto-deleting backups and Snapshot copies in the volume. To meet this space SLO, the following volume-level settings are automatically set and cannot be modified:
It's similar to Unix style permission bits:
In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users.
In Data ONTAP Cluster-Mode, for security style "mixed" or "unix", the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style "ntfs", the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Possible values:
Security styles don't apply to GX-striped data volumes.
Possible values:
Possible values:
Outputs
[Family: vserver]
Create a volume. The ability to create Infinite Volumes has been removed as of Data ONTAP 9.4. When creating a FlexGroup, four constituents will be created on every aggregate specified in the aggr-list parameter. An aggregate may be specified multiple times to have extra constituents created on it. The default value of four constituents per aggregate can be overriden by specifying a different value for the aggr-list-multiplier parameter. This API is not supported for FlexGroup constituents.Inputs
This policy can be created using the 'volume-efficiency-policy-create' API. This parameter is not supported for FlexGroups.
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API. This parameter is not supported for FlexGroups.
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API. This parameter is not supported for FlexGroups.
The volume's constituents would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume's constituents.
By default, this value is true.
When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable. This parameter is not supported for FlexGroups.
The fully-qualified pathname in the owning Vserver's namespace at which the volume is mounted. The pathname is case insensitive. This string must begin with '/'. In addition, it must not end with '/'. The pathname must be unique within a Vserver's namespace.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned. For FlexGroups the following rules apply:
The pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length.
An example of a valid junction path is: '/user/my_volume'. If the junction-path is not specified, the FlexGroup is not mounted.
To use UTF-8 as the NFS character set, append '.UTF-8' to the language code. This parameter is only supported for FlexGroups.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
The default policy name for FlexGroups is 'default'.
none: The value of none does not provide any guarantee for overwrites or enforce any restrictions. It should be used if the admin plans to manually manage space consumption in the volume and aggregate, and out of space errors.
thick: The value of thick guarantees that the hole fills and overwrites to space-reserved files in this volume will always succeed by reserving space. To meet this space SLO, the following volume-level settings are automatically set and cannot be modified:
semi-thick: The value of semi-thick is a best-effort attempt to ensure that overwrites succeed by restricting the use of features that share blocks and auto-deleting backups and Snapshot copies in the volume. To meet this space SLO, the following volume-level settings are automatically set and cannot be modified:
If the client specifies this argument upon Infinite Volume creation, the argument will be used as the initial storage service for constituents of the Infinite Volume.
If the client does not specify this argument upon Infinite Volume creation, the Infinite Volume will be created without support for storage services. Support for storage services can be enabled at a later time using the volume-modify-iter-async API. This parameter is only supported on Infinite Volumes.
It's similar to Unix style permission bits:
The default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Possible values:
Security styles don't apply to GX-striped data volumes.
Possible values:
Possible values:
Outputs
[Family: vserver]
Destroy the specified volume or plex. If a flexible volume is specified, all of its blocks are freed and returned to its containing aggregate; no other flexible volumes in the same containing aggregate (if any) are affected. If a traditional volume is specified, all of its plexes are destroyed, and its disks are returned to the appropriate spare pool(s). If a plex is specified, it must be for a mirrored aggregate (which could potentially be embedded in a traditional volume), leaving it unmirrored. Only offline volumes and plexes can be destroyed. Plexes are not supported for Cluster-Mode volumes.This API is not supported for FlexGroups or Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Destroy a volume. The volume must be unmounted and must be offline before it can be destroyed.This API is not supported for Flexible Volumes, Infinite Volume constituents or FlexGroup constituents.
Inputs
Outputs
[Family: cluster, vserver]
Display the encryption status of all volumes undergoing encryptionInputs
Outputs
[Family: vserver]
Pause Volume Encryption ConversionInputs
Outputs
[Family: vserver]
Resume Paused Volume Encryption ConversionInputs
Outputs
[Family: vserver]
Start Encryption Conversion of a VolumeInputs
Outputs
[Family: cluster]
Verifies that there are no encrypted volumes in the system and configures encryption feature for downgrade.Inputs
Outputs
[Family: cluster, vserver]
Display the encryption status of all volumes undergoing encryption rekeyInputs
Outputs
[Family: vserver]
Pause Volume Encryption RekeyInputs
Outputs
[Family: vserver]
Resume Paused Volume Encryption RekeyInputs
Outputs
[Family: vserver]
Rekey a VolumeInputs
Outputs
[Family: vserver]
Allows the user to increase the size of a FlexGroup by adding constituents. The size of the new constituents is determined by the size of the smallest existing constituent.This API is not supported for Flexible Volumes, FlexGroup constituents, Infinite Volumes or Infinite Volume constituents.
Inputs
Outputs
[Family: cluster, vserver]
Get the current footprint in the capacity tier for FlexGroups.Inputs
Outputs
[Family: cluster, vserver]
This API is no longer supported as of ONTAP 9.6.0. Use the volume-create-async API with the auto-provision-as parameter instead.Deploys a FlexGroup on the cluster.
The FlexGroup is created with 8 constituents on each node in the cluster. The constituents are split equally between the two largest aggregates on each node. If using two aggregrates per node is not possible, all of the constituents are created on the largest aggregate on each node.
This API is only supported on clusters with 4 nodes or less. On clusters with more than 4 nodes, use the volume-create-async API to create FlexGroups.
Inputs
Outputs
[Family: vserver]
This API is no longer supported as of ONTAP 9.6.0. Use the volume-flexgroup-get-create-limits API instead.Get the aggregate layout that will be created when deploying a FlexGroup.
Return calculated number of aggregates, estimated aggregate capacity, disk count and disk type.
Inputs
Outputs
[Family: vserver]
Get a preivew of FlexGroup creation. If manually selecting the aggregates to create the FlexGroup, this API will return the minimum and maximum size allowable for the FlexGroup. If using auto provisioinig, this API will return the minimum and maximum size allowable, along with the type of disks that can support the maximum allowable size. If a size is specified, the API will also return the list of aggregates that will be used to create a FlexGroup of the requested size, along with the type of disks that would be used. If a size is specified and a FlexGroup cannot be provisioned for the specified size, the API will not return an error when using auto provisioning. An error is only returned for auto provisioning if no FlexGroup of any size can be created on any aggregates.Inputs
Outputs
[Family: vserver]
Get the minimum and maximum expand limits for a FlexGroup.Inputs
Outputs
[Family: vserver]
Get the minimum and maximum resize limits for a FlexGroup.Inputs
Outputs
[Family: cluster, vserver]
Display a list of volumes and their data and metadata footprints in their parent aggregate. The term footprint is used to refer to space that is considered used in an aggregate due to data in a specific volume. Some fields are expensive to compute, if the system is under load, the information may not be returned. Best practise would be to only request the fields needed.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of volume objects.Inputs
Outputs
[Family: vserver]
Get the given volume's language mapping.Inputs
Outputs
This field is of the following format: "<nfs-character-set>|<display-name>|<asctime>"
Note that "|" is not an OR syntax.
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: "A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12."
It uses the C Programming Language Printf format: "%.3s %.3s%3d %02d:%02d:%02d %s %d"
This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second>, <timezone> OR <"">, <year>
E.g., If the volume language code is set to "en_US", the default NFS character set is as follows:
"iso-8859-1|iso-8859-1|Thu Oct 1 15:00:53 PDT 1998"
This field is of the following format: "<oem-code-page>|<display-name>|<asctime>"
Note that "|" is not an OR syntax.
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: "A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12."
It uses the C Programming Language Printf format: "%.3s %.3s%3d %02d:%02d:%02d %s %d"
This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second>, <timezone> OR <"">, <year>
E.g., If the volume language code is set to "en_US", the default NFS character set is as follows:
"cp437|cp437|Thu Oct 1 15:00:53 PDT 1998"
[Family: vserver]
Return calculated volume limits, which are based on the current configuration of the Vserver. If an Infinite Volume already exists on the Vserver, the values returned are in relation to the existing volume.This API is only supported for Infinite Volumes.
Inputs
Possible values:
Outputs
[Family: vserver]
Return the name of the "root" volume on the filer. If this request is executed in the context of a vfiler, the "root" volume of the vfiler will be returned. If this request is executed in the context of a Vserver the "namespace root" volume of the Vserver will be returned. If the "namespace root" volume of the Admin Vserver is requested, EVSERVER_OP_NOT_ALLOWED will be returned.Inputs
Outputs
[Family: vserver]
Return the junction-path of the volume.Inputs
Outputs
[Family: cluster, vserver]
Modify the attributes of a volume or a group of volume objects.This API is not supported for Infinite Volumes or FlexGroups.
Inputs
Outputs
[Family: cluster, vserver]
Modify the attributes of an Infinite Volume, FlexGroup or a group of Infinite Volumes and FlexGroups.Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation of expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initilization is complete. While in a 'mixed' state, further operations of the Infinite Volume are not possible.
This API is not supported for Flexible Volumes, Infinite Volume constituents or FlexGroup constituents. This API does not require any license when operating on an Infinite Volume.
Inputs
Outputs
[Family: vserver]
Mount a volume on another volume (parent) with a junction-path. This API is not supported on Infinite Volume constituents.Inputs
The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's context. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An Infinite Volume has the additional restriction of allowing only one element.
An example of a valid FlexVol or FlexGroup junction path is: '/user/my_volume'. An example of a valid Infinite Volume junction path is: '/repository'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If this volume is mounted at a different junction path, or if another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
Outputs
[Family: cluster]
Get status of move operationInputs
Outputs
[Family: cluster]
Pause running volume move operation.Inputs
Outputs
[Family: cluster]
Resume running volume move operation.Inputs
Outputs
[Family: cluster]
Initially this API will run a series of checks to determine if the volume can be moved. If any of the checks results in an error or warning, the API will return with an error. The user has to take the necessary corrective action before restarting the move. If all the checks pass, the API will return a success. If "perform-validation-only" is set to true, all the errors and warnings encountered from the checks will be returned in the errors-warnings output element. The API will return successfully, and the move will not be initiated. By default "perform-validation-only" is false, which means that the destination volume will be created and the move will start. A flexvol can be moved to any aggregate in the cluster, but if the flexvol is a member of an infinite volume it can only be moved to any eligible aggregate within the same vserver. The list of eligible aggregates can be obtained using the "volume-move-target-aggr-get-iter" API. The Cluster-mode API, supports the actions of "cutover-window", "cutover-attempts" and "cutover-action".The status of the move job can be obtained by using the "volume-move-get-iter" API and "job-get" or "job-get-iter" APIs. If the move fails an EMS message will be generated. The reason for the failure can be obtained from the volume-move-get-iter API.Inputs
Outputs
[Family: cluster]
Scans aggregates and returns a list of compatible target aggregates for the given volume move operation.Inputs
Outputs
[Family: cluster]
Stop a running volume move operation.This is an asynchrous API call and it does not wait for the abort to finish before returning. volume-move-get-iter can be used to monitor the progress of the abort and get the status. Unlike 'job stop', this API makes it possible to stop a move job by the vserver and volume name. If the specified volume has completed the volume move operation, an error is returned.
Inputs
Outputs
[Family: cluster]
Trigger cutover of a move jobInputs
Outputs
[Family: vserver]
Take the specified volume or plex offline, making it unavailable for both user-level data access and RAID-level access (unless it's a flexible volume, at which time its containing aggregate is not affected in any way, and will remain fully online). The operation takes effect before the API returns except in maintenance mode, when the current root volume may not be taken offline. A volume marked to become the root cannot be taken offline. Taking a flexible volume offline does not affect its containing aggregate in any way. A number of operations being performed on the given volume (or its containing aggregate) can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files on the volume opened by internal ONTAP processes. The command is aborted if any are found. Plexes are not supported for Cluster-Mode volumes.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Take the specified volume offline, thereby making it unavailable for data access. The volume must be unmounted before it can be made offline.This API is not supported for Flexible Volumes, Infinite Volume constituents or FlexGroup constituents.
Inputs
Outputs
[Family: vserver]
Bring the specified volume or the plex online. This command takes effect immediately. If there are CIFS shares associated with the volume, they are enabled. Plexes are not supported for Cluster-Mode volumes.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Bring the specified volume online.This API is not supported for Flexible Volumes, Infinite Volume constituents or FlexGroup constituents.
Inputs
Outputs
[Family: vserver]
Get the options that have been set for the specified volume.Inputs
Outputs
[Family: cluster]
Rehosts a volume from one Vserver into another Vserver. Since volume rehost is a disruptive operation, administrators must stop all data access on target volume before rehosting. On success, target volume is available for data access under destination Vserver. Upon failure the rehost operation is reverted and target volume is available under source Vserver.Inputs
Outputs
[Family: vserver]
Renames the specified volume to a new name specified by "new-volume-name". If the volume is referenced in the /etc/exports file, remember to make the name change in /etc/exports also so that the affected file system can be exported by the filer after the filer reboots. The "volume-rename" command does not automatically update the /etc/exports file. This API is not supported for Infinite Volumes or FlexGroups. This API is supported for FlexGroup constituents, but must be of the format Inputs Outputs
[Family: vserver] This API is not supported for Flexible Volumes or Infinite Volume constituents. This API is supported for FlexGroup constituents, but must be of the format Inputs Outputs
[Family: vserver] This API is not supported for Infinite Volumes. This API is not supported on Infinite Volume constituents. Inputs Outputs
[Family: vserver] This API is not supported for Flexible Volumes, Infinite Volume constituents or FlexGroup constituents. Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] This API is not supported for FlexGroups, FlexGroup constituents, Infinite Volumes or Infinite Volume constituents. Also, this API does not allow to set the volume's size from vFiler context. Inputs Outputs
[Family: vserver] This API is not supported for flexible volumes, Infinite Volume constituents or FlexGroup constituents. Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Possible values: If this argument is not provided, then it is equivalent to setting 'desired-levels' to 'all'. If this argument is not provided, the default is 'all'. Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: vserver] Inputs Under certain circumstances, such as an unexpected reboot while in the middle of unmounting, the unmount operation might find that after the reboot, it is unable to delete the junction path at which the volume is mounted in the file system. In this situation, if the force option is set to false, the unmount operation is failed (EJUNCTIONDELETEFAILED), leaving the junction path information intact in the Volume Management Database. Instead, if the force option is set to true, the unmount operation proceeds to delete the junction path information in the Volume Management Database, irrespective of any failure to delete the junction path in the file system. Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Specifies if this Vserver is a Vserver with Infinite Volume. When part of vserver-get-iter call, this will return the list of matching Vservers. Default value is false. Prior to Data ONTAP 8.2.0, Vserver with Infinite Volume is called repository Vserver and once a repository Vserver is created in a cluster, additional Vservers cannot be created. Conversely, a repository Vserver cannot be created if non-repository Vservers already exist in a cluster. Outputs
[Family: cluster] Inputs Specifies if this Vserver is a Vserver with Infinite Volume. When part of vserver-get-iter call, this will return the list of matching Vservers. Default value is false. Prior to Data ONTAP 8.2.0, Vserver with Infinite Volume is called repository Vserver and once a repository Vserver is created in a cluster, additional Vservers cannot be created. Conversely, a repository Vserver cannot be created if non-repository Vservers already exist in a cluster. Outputs
[Family: vserver] Export a data policy for a Vserver with an Infinite Volume. The data policy is exported as a JSON string. For a description of the JSON format, please refer to the Clustered Data ONTAP Infinite Volumes Management Guide. Inputs Outputs
[Family: vserver] Import a data policy for a Vserver with an Infinite Volume. The data policy is imported as a JSON string. For a description of the required JSON format, please refer to the Clustered Data ONTAP Infinite Volumes Management Guide. Inputs Outputs
[Family: vserver] Validate without importing a data policy for a Vserver with an Infinite Volume. The data policy needs to be specified as a JSON string. For a description of the required JSON format, please refer to the Clustered Data ONTAP Infinite Volumes Management Guide. Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster, vserver] Inputs Outputs
[Family: cluster] Inputs Outputs
[Family: vserver] Inputs Outputs
[Family: vserver] Inputs Outputs
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields Attributes: key, non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: key, non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields Attributes: non-creatable, modifiable Attributes: non-creatable, modifiable Attributes: non-creatable, modifiable Attributes: non-creatable, modifiable Possible values: Attributes: non-creatable, modifiable Attributes: non-creatable, modifiable Attributes: non-creatable, modifiable Attributes: non-creatable, modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields Attributes: key, required-for-create, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields Attributes: non-creatable, non-modifiable Attributes: key, non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: key, non-creatable, non-modifiable Attributes: non-creatable, non-modifiable Attributes: non-creatable, non-modifiable
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields Possible values are: "aborting" - wafliron is aborting. "checking_lost_blocks" - wafliron is checking for lost blocks. "checking_lost_inodes" - wafliron is checking link counts. "finishing" - wafliron is cleaning up. "not_running" - wafliron is not running on this aggregate. "scanning" - wafliron is scanning inodes, and/or fixing file system inconsistencies. "starting" - wafliron is starting, allocating, and/or in the initial mounting phase. "unknown" - wafliron state could not be determined.
Fields
Fields
The following are the possible values for checksum type and their meanings. Fields
Fields
Fields
The following are the possible values for disk position type of the aggregate and their meanings. Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
The following are the possible values for RAID type and their meanings. Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
Fields
The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An example of a valid FlexVol or FlexGroup junction path is: '/user/my_volume'. An example of a valid Infinite Volume junction path is: '/repository'. Only one volume can be mounted at any given junction path. Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute. Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
New volume name.
Name of an existing volume.
volume_rename_async
New name of the volume.
Name of an existing volume.
Error code, if the operation caused an error.
Error description, if the operation caused an error.
Job Id, if this operation was performed via a job.
The operation status. Possible values: "succeeded", "in_progress", "failed".volume_restrict
Name of the volume to restrict.
volume_restrict_async
Name of an existing volume.
Error code, if the operation caused an error.
Error description, if the operation caused an error.
Job Id, if this operation was performed via a job.
The operation status. Possible values: "succeeded", "in_progress", "failed".volume_set_option
Name of the option to be set. Possible values:
The value to set the named option (except for option 'root', which has no associated value).
Name of the volume for which we want to set an option.
volume_set_total_files
Indicates whether the filer should reject a legal but "unreasonable" (seemingly too large) value for 'requested-total-files', or accept it without question. By default, legal but "unreasonable" values are rejected.
Specifies the new value for the volume's 'files-total' field. This value must be larger than the volume's current 'files-total' value, and can never be larger than the number of 4KB blocks in the volume. The filer may actually choose a smaller value so as to comply with certain internal accounting and alignment requirements. Once this value has been increased for a volume, it cannot be reduced below the value of 'inodefile-public-capacity' for that volume. Range : [0..2^31-1]
The name of the volume whose 'files-total' field we wish to set. The chosen volume must be online and not read-only for this operation to succeed.
The quantity to which the given volume's 'files-total' field was actually set after all internal requirements and alignments were computed. This quantity will never be larger than 'requested-total-files', and never be smaller than the volume's 'inodefile-public-capacity' value before the request. Range : [0..2^31-1]volume_size
Specify the flexible volume's new size using the following format: [+|-]< number > k|m|g|t] If a leading '+' or '-' appears, it indicates that the given flexible volume's size is to be increased or decreased (respectively) by the indicated amount, else the amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of bytes desired. The file system size of a readonly replica flexible volume, such as a snapmirror destination, is determined from the replica source. In such cases, the value set using "volume-size" is interpreted as an upper limit on the size. A flexible volume that's not a readonly replica which has the "fs_size_fixed" option set may have its size displayed, but not changed. Attempting to set the volume size in this case will result in failure and a EINTERNALERROR error code. Users must be able to adjust readonly replica flexible volume size in order to maintain enough capacity to accommodate transfers from the replica source. Attempting to set a readonly replica destination size to be less than that of its source will result in a failure indicated by the EONTAPI_ENOSPC error code. This option is not applicable from vFiler context. Attempting to set volume size from vfiler context will result in failure with EINTERNALERROR error code being returned.
The name of the flexible volume for which we want to get or set its size.
Is the flexible volume filesystem size fixed?
Is this flexible volume read only?
Is this flexible volume a replica volume?
Either the size we found the given volume to be or the size to which the volume was set (if we're setting its size via the 'new-size' argument above).volume_size_async
Specify the volume's new size using the following format: [+|-]< number > [k|m|g|t|p] If a leading '+' or '-' appears, it indicates that the given volume's size is to be increased or decreased (respectively) by the indicated amount, else the amount is the absolute size to set. The optional trailing 'k', 'm', 'g', 't', and 'p' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', 'terabytes', and 'petabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of kilobytes desired. The file system size of a readonly volume, such as a snapmirror destination, is determined from the snapmirror source. In such cases, the value set using this API is interpreted as an upper limit on the size. An volume that's not a snapmirror destination which has the "fs_size_fixed" option set may have its size displayed, but not changed. Attempting to set the volume size in this case will result in failure and a EINTERNALERROR error code. Users must be able to adjust readonly snapmirror destination volume size in order to maintain enough capacity to accommodate transfers from the replica source. Attempting to set a readonly snapmirror destination size to be less than that of its source will result in a failure indicated by the EONTAPI_ENOSPC error code. If this input is specified, the size modification occurs asynchronously, and the 'volume-size' output is not returned to the caller. Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation or expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initialization is complete. While in a 'mixed' further operations of the Infinite Volume are not possible. This parameter is not supported on Infinite Volumes that are managed by storage services.
The name of the volume.
Error code, if the operation caused an error.
Error description, if the operation caused an error.
Job Id, if this operation was performed via a job.
The operation status. Possible values: "succeeded", "in_progress", "failed".
The size of the volume. This output is returned only if the caller is querying the the size and is not modifying it by specifying the 'new-size' input parameter.volume_space_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-space object. All volume-space objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of volume-space objects.
Tag for the next call. Not present when there are no more volume-space objects to return.
The number of records returned in this call.volume_storage_service_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-storage-service object. All volume-storage-service objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of volume-storage-service objects.
Tag for the next call. Not present when there are no more volume-storage-service objects to return.
The number of records returned in this call.volume_storage_service_rename
New Storage Service Name
Storage Service Name
Volume Name
volume_tiering_policies_list
volume_transition
The name of the vserver into which a volume is being transitioned.
A 'true' value indicates that only a non-disruptive transition will be accepted. This is not available for all volume configurations. If a value is not specified, this field will default to true - non-disruptive desired.
The type of transition operation; Possible values are: "copy_based" (default) "in_place" "untransition" Copy Based Transition is currently the only supported mode for transition; "in_place" and "untransition" should only be used in testing scenarios.
A 'true' value indicates that all warnings will be ignored as a part of the transition process. The system will select default values as appropriate. If not specified, values will not be overridden.
The name of the node where the target volumes reside.
Job id which can be used to query the status of the process.volume_transition_check
The name of the vserver into which a volume is being transitioned.
A 'true' value indicates that only a non-disruptive transition will be accepted. This is not available for all volume configurations. If a value is not specified, this field will default to true - non-disruptive desired.
The type of transition operation; Possible values are: "copy_based" (default) "in_place" "untransition" Copy Based Transition is currently the only supported mode for transition; "in_place" and "untransition" should only be used in testing scenarios.
A 'true' value indicates that all warnings will be ignored as a part of the transition process. The system will select default values as appropriate. If not specified, values will not be overridden.
The name of the node where the target volumes reside.
Volumes to check for the ability to transition to Cluster-Mode.
volume_transition_log_delete
The name of the containing vserver for the volume, if applicable.
The type of transition operation; Possible values are: "transition" (default) "untransition" Transition is currently the only supported mode; "untransition" should only be used in testing scenarios.
Node owning the 7-mode volumes being transitioned
Volumes to delete the transition log from.
volume_transition_log_get_iter
The list of the specific features whose log records are desired by the caller. The caller can either specify a list of features or "all" to include all phases. If this argument is not provided, then it is equivalent to setting 'desired-features' to 'all'.
The list of the specific level log records which are desired by the caller. The caller can either specify a list of levels or "all" to include all levels.
The list of the specific phases whose log records are desired by the caller. To receive all phases, "all" can be specified. Possible values:
The name of the containing vserver for the volume, if applicable.
The maximum number of records to return
The type of transition operation; Possible values are: "transition" (default) "untransition" Transition is currently the only supported mode; "untransition" should only be used in testing scenarios.
Node owning the 7-Mode volumes being transitioned.
Value to use to get next entry.
Volume to obtain transition log information from.
True if there are no more entries to read.
Value to use to get next entry.
Number of records being returned.volume_transition_prepare_to_downgrade
volume_transition_protect
Protection Enabled
The name of the volume.
The name of the Vserver which owns the volume.
volume_unmount
This specifies whether the volume unmount operation is forced or not. The default value is false.
The name of the volume.
vscan_active_scanner_pool_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-active-scanner-pool object. All vscan-active-scanner-pool objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-active-scanner-pool objects.
Tag for the next call. Not present when there are no more vscan-active-scanner-pool objects to return.
The number of records returned in this call.vscan_connection_extended_stats_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-connection-extended-stats object. All vscan-connection-extended-stats objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-connection-extended-stats objects.
Tag for the next call. Not present when there are no more vscan-connection-extended-stats objects to return.
The number of records returned in this call.vscan_connection_status_all_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-connection-status-all object. All vscan-connection-status-all objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-connection-status-all objects.
Tag for the next call. Not present when there are no more vscan-connection-status-all objects to return.
The number of records returned in this call.vscan_events_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-events object. All vscan-events objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-events objects.
Tag for the next call. Not present when there are no more vscan-events objects to return.
The number of records returned in this call.vscan_on_access_policy_create
File extensions for which On-Access scanning must not be performed.
File extensions for which On-Access scanning is considered. The default value is '*', which means that all files are considered for scanning except those which are excluded from scanning.
A list of filters which can be used to define the scope of the On-Access policy more precisely. The filters can be added in any order. Possible values:
Specifies whether access to a file is allowed if there are no external virus-scanning servers available for virus scanning. It is true if not provided at the time of creating a policy.
Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy.
File paths for which On-Access scanning must not be performed.
Name of the policy.
File-Access protocol to monitor for On-Access scanning. Possible values:
If set to true, returns the vscan-on-access-policy on successful creation. Default: false
Specifies whether files without any extension are considered for scanning or not. The default value is true.
The vscan-on-access-policy created (keys or the entire object if requested)vscan_on_access_policy_delete
Name of the policy.
vscan_on_access_policy_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-on-access-policy object. All vscan-on-access-policy objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-on-access-policy objects.
Tag for the next call. Not present when there are no more vscan-on-access-policy objects to return.
The number of records returned in this call.vscan_on_access_policy_modify
File extensions for which On-Access scanning must not be performed.
File extensions for which On-Access scanning is considered. The default value is '*', which means that all files are considered for scanning except those which are excluded from scanning.
A list of filters which can be used to define the scope of the On-Access policy more precisely. The filters can be added in any order. Possible values:
Specifies whether access to a file is allowed if there are no external virus-scanning servers available for virus scanning. It is true if not provided at the time of creating a policy.
Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy.
File paths for which On-Access scanning must not be performed.
Name of the policy.
Specifies whether files without any extension are considered for scanning or not. The default value is true.
vscan_on_access_policy_status_modify
Name of the policy.
Policy Status
vscan_on_demand_report_delete
Specifies if report file also need to be deleted. Default is false.
Path of the report file from root of the Vserver.
Name of the task.
vscan_on_demand_report_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-on-demand-report object. All vscan-on-demand-report objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-on-demand-report objects.
Tag for the next call. Not present when there are no more vscan-on-demand-report objects to return.
The number of records returned in this call.vscan_on_demand_task_create
Specifies whether the On-Demand task is allowed to cross volume junctions. If the parameter is set to false, crossing junctions is not allowed. Default is true.
Specifies whether the On-Demand task is allowed to recursively scan through sub-directories. If the parameter is set to false, recursive scanning is not allowed. Default is true.
File-Extensions for which scanning must not be performed. File whose extension matches with both inclusion and exclusion list is not considered for scanning.
File extensions for which scanning is considered. The default value is '*', which means that all files are considered for scanning except those which are excluded from scanning. File whose extension matches with both inclusion and exclusion list is not considered for scanning.
Max file-size (in bytes) allowed for scanning. The default value of 10737418240 (10GB) is taken if not provided at the time of creating a task.
File-paths for which scanning must not be performed.
Path from the vserver root where task report is created. The path must be a directory and provided in unix-format from the root of the Vserver. Example: /vol1/on-demand-reports.
Log level for the On-Demand report. Default is error. Possible values:
Total request-service time-limit in seconds. If the virus-scanner does not respond within the provided time, scan will be timedout.
If set to true, returns the vscan-on-demand-task on successful creation. Default: false
Specifies whether files without any extension are considered for scanning or not. The default value is true.
List of paths that need to be scanned. The path must be provided in unix-format and from the root of the Vserver. Example: /vol1/large_files.
Priority of the On-Demand scan requests generated by this task. Default is low. Possible values:
Schedule of the task. The task will be run as per the schedule. For running the task immediately, vscan-on-demand-task-run api must be used after creating a task.
Name of the task.
The vscan-on-demand-task created (keys or the entire object if requested)vscan_on_demand_task_delete
Name of the task.
vscan_on_demand_task_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-on-demand-task object. All vscan-on-demand-task objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-on-demand-task objects.
Tag for the next call. Not present when there are no more vscan-on-demand-task objects to return.
The number of records returned in this call.vscan_on_demand_task_modify
Specifies whether the On-Demand task is allowed to cross volume junctions. If the parameter is set to false, crossing junctions is not allowed. Default is true.
Specifies whether the On-Demand task is allowed to recursively scan through sub-directories. If the parameter is set to false, recursive scanning is not allowed. Default is true.
File-Extensions for which scanning must not be performed. File whose extension matches with both inclusion and exclusion list is not considered for scanning.
File extensions for which scanning is considered. The default value is '*', which means that all files are considered for scanning except those which are excluded from scanning. File whose extension matches with both inclusion and exclusion list is not considered for scanning.
Max file-size (in bytes) allowed for scanning. The default value of 10737418240 (10GB) is taken if not provided at the time of creating a task.
File-paths for which scanning must not be performed.
Path from the vserver root where task report is created. The path must be a directory and provided in unix-format from the root of the Vserver. Example: /vol1/on-demand-reports.
Log level for the On-Demand report. Default is error. Possible values:
Total request-service time-limit in seconds. If the virus-scanner does not respond within the provided time, scan will be timedout.
Specifies whether files without any extension are considered for scanning or not. The default value is true.
List of paths that need to be scanned. The path must be provided in unix-format and from the root of the Vserver. Example: /vol1/large_files.
Priority of the On-Demand scan requests generated by this task. Default is low. Possible values:
Schedule of the task. The task will be run as per the schedule. For running the task immediately, vscan-on-demand-task-run api must be used after creating a task.
Name of the task.
vscan_on_demand_task_run
Task Name
vscan_reset
vscan_resolve_hostnames
Name of the virus scanner pool.
vscan_scanner_pool_apply_policy
Cluster on Which Policy Is Applied
Scanner Policy
Name of the virus scanner pool.
vscan_scanner_pool_create
List of hostnames of Vscan servers which are allowed to connect to clustered Data ONTAP.
Maximum number of consecutive session-setup attempts. The value for this field must be between 1 and 5. The default value of 5 is taken if not provided while creating a scanner pool.
List of privileged users.
Total request-service time-limit in seconds. It is used to specify the time interval in which the node waits for a response from the Vscan server. If the timeout is reached, the node allows the file-operation if the applicable On-Access policy has scan-mandatory set to \"off\". If the policy has scan-mandatory set to \"on\", the node will retry the scan or disallow the file-operation depending on the remaining lifetime of the CIFS request. Valid values for this field are from 10s to 40s. However, if scan-mandatory is set to \"off\", the effective value is limited to a maximum of 35s. The default value of 30 is taken if not provided while creating a scanner pool.
If set to true, returns the vscan-scanner-pool on successful creation. Default: false
Scan-queue wait-time-limit in seconds. The value for this field must be between 10s and 30s. The default value of 20 is taken if not provided while creating a scanner pool.
Name of the virus scanner pool.
List of IP addresses of Vscan servers which are allowed to connect to clustered Data ONTAP.
Total session-setup time-limit in seconds. The value for this field must be between 5s and 10s. The default value of 10 is taken if not provided while creating a scanner pool.
Total session-teardown time-limit in seconds. The value for this field must be between 5s and 10s. The default value of 10 is taken if not provided while creating a scanner pool.
The vscan-scanner-pool created (keys or the entire object if requested)vscan_scanner_pool_delete
Name of the virus scanner pool.
vscan_scanner_pool_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-scanner-pool object. All vscan-scanner-pool objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-scanner-pool objects.
Tag for the next call. Not present when there are no more vscan-scanner-pool objects to return.
The number of records returned in this call.vscan_scanner_pool_modify
List of hostnames of Vscan servers which are allowed to connect to clustered Data ONTAP.
Maximum number of consecutive session-setup attempts. The value for this field must be between 1 and 5. The default value of 5 is taken if not provided while creating a scanner pool.
List of privileged users.
Total request-service time-limit in seconds. It is used to specify the time interval in which the node waits for a response from the Vscan server. If the timeout is reached, the node allows the file-operation if the applicable On-Access policy has scan-mandatory set to \"off\". If the policy has scan-mandatory set to \"on\", the node will retry the scan or disallow the file-operation depending on the remaining lifetime of the CIFS request. Valid values for this field are from 10s to 40s. However, if scan-mandatory is set to \"off\", the effective value is limited to a maximum of 35s. The default value of 30 is taken if not provided while creating a scanner pool.
Scan-queue wait-time-limit in seconds. The value for this field must be between 10s and 30s. The default value of 20 is taken if not provided while creating a scanner pool.
Name of the virus scanner pool.
List of IP addresses of Vscan servers which are allowed to connect to clustered Data ONTAP.
Total session-setup time-limit in seconds. The value for this field must be between 5s and 10s. The default value of 10 is taken if not provided while creating a scanner pool.
Total session-teardown time-limit in seconds. The value for this field must be between 5s and 10s. The default value of 10 is taken if not provided while creating a scanner pool.
vscan_status_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-status object. All vscan-status objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vscan-status objects.
Tag for the next call. Not present when there are no more vscan-status objects to return.
The number of records returned in this call.vscan_status_modify
Vscan status. When true, Vscan feature is enabled for the Vserver.
vserver_add_aggregates
Specifies a list of aggregates to be added to the Vserver. The root aggregates should not be specified in this list because though the command will return success, volumes cannot be created on root aggregates. In a MetroCluster configuration, this command does not honor the remote cluster's aggregates.
Specifies the name of the Vserver for which aggregates are to be added.
vserver_add_protocols
Is the list of protocols to be added to the vserver specified. Possible values are: 'nfs', 'cifs', 'fcp', 'iscsi', and 'ndmp'.
Specifies the name of the Vserver on which the given set of protocols are allowed.
vserver_config_diff_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Name of destination Vserver
The count of object instance
List of key:value pairs of the specific configuration instance compared - for example, volume:vol1
The Vserver configuration object compared - for example, volume
The attributes of the vserver.vserver_config_diff_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver object. All vserver objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver objects.
Tag for the next call. Not present when there are no more vserver objects to return.
The number of records returned in this call.vserver_create
{Deprecated, this field does not have any effect on the operation of the vserver.} Antivirus policy. When specified as part of vserver-create, this field represents the antivirus on access policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
The caching policy that is to be associated with this Vserver. This policy is used to make caching decisions for this Vserver. If a caching policy is not assigned to this Vserver, the system uses the default cluster-wide policy. The possible options for this value are:
Default caching-policy is auto.
Comment. When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
IPspace name. The default value is 'Default'
This parameter is no longer supported as of ONTAP 9.5.0. If you are using Infinite Volumes it is recommended that you do not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.
Whether to perform logical space accounting on new volume create
Whether to report space logically on new volume create
Language to use for the Vserver. Default: C.UTF-8. Available language codes are: 'c' .............. POSIX 'ar' ............. Arabic 'cs' ............. Czech 'da' ............. Danish 'de' ............. German 'en' ............. English 'en_us' .......... English (US) 'es' ............. Spanish 'fi' ............. Finnish 'fr' ............. French 'he' ............. Hebrew 'hr' ............. Croatian 'hu' ............. Hungarian 'it' ............. Italian 'ja' ............. Japanese euc-j 'ja_v1' .......... Japanese euc-j 'ja_jp.pck' ...... Japanese PCK (sjis) 'ja_jp.932' ...... Japanese cp932 'ja_jp.pck_v2' .... Japanese PCK (sjis) 'ko' ............. Korean 'no' ............. Norwegian 'nl' ............. Dutch 'pl' ............. Polish 'pt' ............. Portuguese 'ro' ............. Romanian 'ru' ............. Russian 'sk' ............. Slovak 'sl' ............. Slovenian 'sv' ............. Swedish 'tr' ............. Turkish 'zh' ............. Simplified Chinese 'zh.gbk' ......... Simplified Chinese (GBK) 'zh_tw' .......... Traditional Chinese euc-tw 'zh_tw.big5' ..... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8'. When specified as part of vserver-create, this field represents the language used for the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers with the specified language. The values with the '*' suffixes are not supported by Clustered ONTAP.
Name Mapping switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Mapping switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Mapping configurations as part of their nm-switch configuration. Possible values: 'file', 'ldap'. default: file. This field is deprecated in Data ONTAP 8.3 and later. 'nameservice-nsswitch-create' should be preferred to specify the name mapping switch order. 'nameservice-nsswitch-modify' should be preferred to specify the name mapping switch order. 'nameservice-nsswitch-get' and 'nameservice-nsswitch-get-iter' APIs must be used to fetch the currently configured name mapping switch order. Possible values:
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. This field is deprecated in Data ONTAP 8.3 and later. 'nameservice-nsswitch-create' should be preferred to specify the name server switch order. 'nameservice-nsswitch-modify' should be preferred to modify the name server switch order. 'nameservice-nsswitch-get' and 'nameservice-nsswitch-get-iter' APIs must be used to fetch the currently configured name server switch order. Possible values:
Quota policy. When specified as part of vserver-create, this field represents the quota policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. This parameter is not supported on a Vserver with Infinite Volume. default: default
If set to true, returns the vserver on successful creation. Default: false
Root volume of the Vserver. Optional field for creating a default Vserver. Not allowed for creation of a dp-destination Vserver. Default value is 'svm_root'.
The aggregate on which the root volume will be created. Optional field for creating a default Vserver. If this field is not provided, the most appropriate aggregate will be selected. Not allowed for creation of a dp-destination Vserver. Creating a root volume on a SnapLock aggregate is not supported.
Security Style of the root volume. Optional field for creating a default Vserver. Not allowed for creation of a dp-destination Vserver. When specified as part of the vserver-create, this field represents the security style for the Vserver root volume. When specified as part of vserver-get-iter call, this will return the list of matching Vservers. Possible values: 'unix', 'ntfs', 'mixed'. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume. Default value is 'unix'. Possible values:
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. The following restrictions are applicable for the Vserver name: - Maximum number of characters supported is 47, and 41 for a Vserver with subtype 'sync-source' - 'all' is a reserved name and should not be used as a Vserver name
Vserver Subtype. This option allows the admin to specify the sub-type of Vserver being created. The possible options for this value are:
If a Vserver is an MCC destination, then it would have the sub-type sync-source. Vserver of sub-type sync-destination cannot be explicitly created by the admin. When a Vserver of sub-type dp-destination is created, most of the management activities are not allowed. Default value is default.
The vserver created (keys or the entire object if requested)vserver_create_async
{Deprecated, this field does not have any effect on the operation of the vserver.} Antivirus policy. When specified as part of vserver-create, this field represents the antivirus on access policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
The caching policy that is to be associated with this Vserver. This policy is used to make caching decisions for this Vserver. If a caching policy is not assigned to this Vserver, the system uses the default cluster-wide policy. The possible options for this value are:
Default caching-policy is auto.
Comment. When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
IPspace name. The default value is 'Default'
This parameter is no longer supported as of ONTAP 9.5.0. If you are using Infinite Volumes it is recommended that you do not upgrade the cluster to a release that is later than Data ONTAP 9.3.0.
Whether to perform logical space accounting on new volume create
Whether to report space logically on new volume create
Language to use for the Vserver. Default: C.UTF-8. Available language codes are: 'c' .............. POSIX 'ar' ............. Arabic 'cs' ............. Czech 'da' ............. Danish 'de' ............. German 'en' ............. English 'en_us' .......... English (US) 'es' ............. Spanish 'fi' ............. Finnish 'fr' ............. French 'he' ............. Hebrew 'hr' ............. Croatian 'hu' ............. Hungarian 'it' ............. Italian 'ja' ............. Japanese euc-j 'ja_v1' .......... Japanese euc-j 'ja_jp.pck' ...... Japanese PCK (sjis) 'ja_jp.932' ...... Japanese cp932 'ja_jp.pck_v2' .... Japanese PCK (sjis) 'ko' ............. Korean 'no' ............. Norwegian 'nl' ............. Dutch 'pl' ............. Polish 'pt' ............. Portuguese 'ro' ............. Romanian 'ru' ............. Russian 'sk' ............. Slovak 'sl' ............. Slovenian 'sv' ............. Swedish 'tr' ............. Turkish 'zh' ............. Simplified Chinese 'zh.gbk' ......... Simplified Chinese (GBK) 'zh_tw' .......... Traditional Chinese euc-tw 'zh_tw.big5' ..... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8'. When specified as part of vserver-create, this field represents the language used for the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers with the specified language. The values with the '*' suffixes are not supported by Clustered ONTAP.
Name Mapping switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Mapping switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Mapping configurations as part of their nm-switch configuration. Possible values: 'file', 'ldap'. default: file. This field is deprecated in Data ONTAP 8.3 and later. 'nameservice-nsswitch-create' should be preferred to specify the name mapping switch order. 'nameservice-nsswitch-modify' should be preferred to specify the name mapping switch order. 'nameservice-nsswitch-get' and 'nameservice-nsswitch-get-iter' APIs must be used to fetch the currently configured name mapping switch order. Possible values:
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. This field is deprecated in Data ONTAP 8.3 and later. 'nameservice-nsswitch-create' should be preferred to specify the name server switch order. 'nameservice-nsswitch-modify' should be preferred to modify the name server switch order. 'nameservice-nsswitch-get' and 'nameservice-nsswitch-get-iter' APIs must be used to fetch the currently configured name server switch order. Possible values:
Quota policy. When specified as part of vserver-create, this field represents the quota policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. This parameter is not supported on a Vserver with Infinite Volume. default: default
Root volume of the Vserver. Optional field for creating a default Vserver. Not allowed for creation of a dp-destination Vserver. Default value is 'svm_root'.
The aggregate on which the root volume will be created. Optional field for creating a default Vserver. If this field is not provided, the most appropriate aggregate will be selected. Not allowed for creation of a dp-destination Vserver. Creating a root volume on a SnapLock aggregate is not supported.
Security Style of the root volume. Optional field for creating a default Vserver. Not allowed for creation of a dp-destination Vserver. When specified as part of the vserver-create, this field represents the security style for the Vserver root volume. When specified as part of vserver-get-iter call, this will return the list of matching Vservers. Possible values: 'unix', 'ntfs', 'mixed'. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume. Default value is 'unix'. Possible values:
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. The following restrictions are applicable for the Vserver name: - Maximum number of characters supported is 47, and 41 for a Vserver with subtype 'sync-source' - 'all' is a reserved name and should not be used as a Vserver name
Vserver Subtype. This option allows the admin to specify the sub-type of Vserver being created. The possible options for this value are:
If a Vserver is an MCC destination, then it would have the sub-type sync-source. Vserver of sub-type sync-destination cannot be explicitly created by the admin. When a Vserver of sub-type dp-destination is created, most of the management activities are not allowed. Default value is default.
The vserver created (keys or the entire object if requested)
Error code, if the operation caused an error.
Error description, if the operation caused an error.
The ID of the job that was spawned to create this vserver.
The operation status. Possible values: "succeeded" if creation completed successfully, "in_progress" if creation is in progress, "failed" if creation failed.vserver_data_policy_export
Data-policy JSON expression. A JSON string, XML escaped and UTF8 encoded.vserver_data_policy_import
Data-policy JSON expression. A JSON string with a maximum length of 50 MB. The string should be XML escaped and use the same encoding as the XML document of which it is a part (UTF8 for APIs).
vserver_data_policy_validation_get_error
Data-policy JSON expression. A JSON string with a maximum length of 50 MB. The string should be XML escaped and use the same encoding as the XML document of which it is a part (UTF8 for APIs).
vserver_destroy
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. The following restrictions are applicable for the Vserver name: - Maximum number of characters supported is 47, and 41 for a Vserver with subtype 'sync-source' - 'all' is a reserved name and should not be used as a Vserver name
vserver_destroy_async
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. The following restrictions are applicable for the Vserver name: - Maximum number of characters supported is 47, and 41 for a Vserver with subtype 'sync-source' - 'all' is a reserved name and should not be used as a Vserver name
Error code, if the deletion operation caused an error.
Error description, if the operation caused an error.
Job Id, if this operation was performed via a job.
The operation status. Possible values: "succeeded", "in_progress", "failed".vserver_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The attributes of the vserver.vserver_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver object. All vserver objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver objects.
Tag for the next call. Not present when there are no more vserver objects to return.
The number of records returned in this call.vserver_http_proxy_create
Specifies the Ipspace for which the HTTP proxy should be configured. this parameter is mutually exclusive with vserver parameter.
Specifies the port number on which the HTTP proxy service is configured for the server.
Specifies the HTTP proxy hostname or IP address.
Skip the config validation
Specifies the vserver for which the HTTP proxy should be configured. This parameter is mutually exclusive with ipsapce parameter.
vserver_http_proxy_delete
Specifies the Ipspace for which the HTTP proxy should be configured. this parameter is mutually exclusive with vserver parameter.
Specifies the vserver for which the HTTP proxy should be configured. This parameter is mutually exclusive with ipsapce parameter.
vserver_http_proxy_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Specifies the Ipspace for which the HTTP proxy should be configured. this parameter is mutually exclusive with vserver parameter.
The attributes of the http-proxy.vserver_http_proxy_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the http-proxy object. All http-proxy objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of http-proxy objects.
Tag for the next call. Not present when there are no more http-proxy objects to return.
The number of records returned in this call.vserver_http_proxy_modify
Specifies the Ipspace for which the HTTP proxy should be configured. this parameter is mutually exclusive with vserver parameter.
Specifies the port number on which the HTTP proxy service is configured for the server.
Specifies the HTTP proxy hostname or IP address.
Skip the config validation
Specifies the vserver for which the HTTP proxy should be configured. This parameter is mutually exclusive with ipsapce parameter.
vserver_login_banner_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The attributes of the vserver-login-banner.vserver_login_banner_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-login-banner object. All vserver-login-banner objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-login-banner objects.
Tag for the next call. Not present when there are no more vserver-login-banner objects to return.
The number of records returned in this call.vserver_login_banner_modify
The login banner message. Maximum byte length for modify: 2048.
vserver_login_banner_modify_iter
This input element is useful when multiple vserver-login-banner objects match a given query. If set to true, the API will continue with the next matching vserver-login-banner even when the operation fails for the vserver-login-banner. If set to false, the API will return on the first failure. Default: false
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching vserver-login-banner even when the operation on a previous matching vserver-login-banner fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
The maximum number of vserver-login-banner objects to be operated in this call. Default: 20
The login banner message. Maximum byte length for modify: 2048.
If operating on a specific vserver-login-banner, this input element must specify all keys. If operating on vserver-login-banner objects based on query, this input element must specify a query.
If set to true, the API will return the list of vserver-login-banner objects (just keys) that were not operated on due to some error. If set to false, the list of vserver-login-banner objects not operated on will not be returned. Default: true
If set to true, the API will return the list of vserver-login-banner objects (just keys) that were successfully operated on. If set to false, the list of vserver-login-banner objects operated on will not be returned. Default: true
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Information about vserver-login-banner objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
Tag for the next call. Not present when there are no more matching vserver-login-banner objects to be operated on.
The number of vserver-login-banner objects that matched the query, but were not operated on due some error.
The number of vserver-login-banner objects that matched the query and were successfully processed.
The vserver-login-banner objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.vserver_modify
List of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. When specified as part of a vserver-create, this field represents the list of aggregates that are assigned to the Vserver for volume operations. When part of vserver-get-iter call, this will return the list of Vservers which have any of the aggregates specified as part of the aggr-list.
Allowed Protocols. When specified as part of a vserver-create, this field represent the list of protocols allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the allowed-protocols. When part of vserver-modify, this field should include the existing list along with new protocol list to be added to prevent data disruptions. Possible values:
{Deprecated, this field does not have any effect on the operation of the vserver.} Antivirus policy. When specified as part of vserver-create, this field represents the antivirus on access policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
The caching policy that is to be associated with this Vserver. This policy is used to make caching decisions for this Vserver. If a caching policy is not assigned to this Vserver, the system uses the default cluster-wide policy. The possible options for this value are:
Default caching-policy is auto.
Comment. When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Disallowed Protocols. When specified as part of a vserver-create, this field represent the list of protocols not allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the disallowed-protocols. When part of vserver-modify, this field should include the existing list along with new protocol list to be added to prevent data disruptions. Possible values:
Whether to perform logical space accounting on new volume create
Whether to report space logically on new volume create
Language to use for the Vserver. Default: C.UTF-8. Available language codes are: 'c' .............. POSIX 'ar' ............. Arabic 'cs' ............. Czech 'da' ............. Danish 'de' ............. German 'en' ............. English 'en_us' .......... English (US) 'es' ............. Spanish 'fi' ............. Finnish 'fr' ............. French 'he' ............. Hebrew 'hr' ............. Croatian 'hu' ............. Hungarian 'it' ............. Italian 'ja' ............. Japanese euc-j 'ja_v1' .......... Japanese euc-j 'ja_jp.pck' ...... Japanese PCK (sjis) 'ja_jp.932' ...... Japanese cp932 'ja_jp.pck_v2' .... Japanese PCK (sjis) 'ko' ............. Korean 'no' ............. Norwegian 'nl' ............. Dutch 'pl' ............. Polish 'pt' ............. Portuguese 'ro' ............. Romanian 'ru' ............. Russian 'sk' ............. Slovak 'sl' ............. Slovenian 'sv' ............. Swedish 'tr' ............. Turkish 'zh' ............. Simplified Chinese 'zh.gbk' ......... Simplified Chinese (GBK) 'zh_tw' .......... Traditional Chinese euc-tw 'zh_tw.big5' ..... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8'. When specified as part of vserver-create, this field represents the language used for the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers with the specified language. The values with the '*' suffixes are not supported by Clustered ONTAP.
Maximum number of volumes that can be created on the Vserver. When specified as part of a vserver-create, this field represents the maximum number of volumes that can be created on the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Name Mapping switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Mapping switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Mapping configurations as part of their nm-switch configuration. Possible values: 'file', 'ldap'. default: file. This field is deprecated in Data ONTAP 8.3 and later. 'nameservice-nsswitch-create' should be preferred to specify the name mapping switch order. 'nameservice-nsswitch-modify' should be preferred to specify the name mapping switch order. 'nameservice-nsswitch-get' and 'nameservice-nsswitch-get-iter' APIs must be used to fetch the currently configured name mapping switch order. Possible values:
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. This field is deprecated in Data ONTAP 8.3 and later. 'nameservice-nsswitch-create' should be preferred to specify the name server switch order. 'nameservice-nsswitch-modify' should be preferred to modify the name server switch order. 'nameservice-nsswitch-get' and 'nameservice-nsswitch-get-iter' APIs must be used to fetch the currently configured name server switch order. Possible values:
The QoS policy group associated with this volume. This optionally specifies which QoS policy group to apply to the Vserver. The policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a Vserver, the system will not monitor and control traffic to it. This parameter is not supported on a Vserver with Infinite Volume.
Quota policy. When specified as part of vserver-create, this field represents the quota policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. This parameter is not supported on a Vserver with Infinite Volume. default: default
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
State of the Virtual Server. This field, together with the operational state, determines the data serving ability of a Vserver Possible values:
The number of hours that a deleted volume should be retained before the delete is completed
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. The following restrictions are applicable for the Vserver name: - Maximum number of characters supported is 47, and 41 for a Vserver with subtype 'sync-source' - 'all' is a reserved name and should not be used as a Vserver name
vserver_modify_iter
Specify at least one modifiable element. Do not specify any other element.
This input element is useful when multiple vserver objects match a given query. If set to true, the API will continue modifying the next matching vserver even when modification of a previous vserver fails. If set to false, the API will return on the first failure. Default: false
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching vserver even when the modification of a previous matching vserver fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
The maximum number of objects to be modified in this call. Default: 20
If modifying a specific vserver, this input element must specify all keys. If modifying vserver objects based on query, this input element must specify a query.
If set to true, the API will return the list of vserver objects (just keys) that were not modified due to some error. If set to false, the list of vserver objects not modified will not be returned. Default: true
If set to true, the API will return the list of vserver objects (just keys) that were successfully updated. If set to false, the list of vserver objects modified will not be returned. Default: true
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Information about vserver objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
Tag for the next call. Not present when there are no more matching vserver objects to be modified.
Number of vserver objects that matched the query, but were not modified due to some error.
The number of vserver objects that matched the query and were successfully updated.
The vserver objects that were successfully updated. This element will be returned only if input element 'return-success-list' is truevserver_motd_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The attributes of the vserver-motd.vserver_motd_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-motd object. All vserver-motd objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-motd objects.
Tag for the next call. Not present when there are no more vserver-motd objects to return.
The number of records returned in this call.vserver_motd_modify
Is the display of the cluster message of the day (MOTD) enabled for this Vserver? This field cannot be modified in a data Vserver context (tunneled to a data Vserver).
The message of the day (MOTD). Maximum byte length for modify: 2048. Newlines can be supplied as either LF or CRLF, but they will always be returned as LF.
vserver_motd_modify_iter
This input element is useful when multiple vserver-motd objects match a given query. If set to true, the API will continue with the next matching vserver-motd even when the operation fails for the vserver-motd. If set to false, the API will return on the first failure. Default: false
Is the display of the cluster message of the day (MOTD) enabled for this Vserver? This field cannot be modified in a data Vserver context (tunneled to a data Vserver).
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching vserver-motd even when the operation on a previous matching vserver-motd fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
The maximum number of vserver-motd objects to be operated in this call. Default: 20
The message of the day (MOTD). Maximum byte length for modify: 2048. Newlines can be supplied as either LF or CRLF, but they will always be returned as LF.
If operating on a specific vserver-motd, this input element must specify all keys. If operating on vserver-motd objects based on query, this input element must specify a query.
If set to true, the API will return the list of vserver-motd objects (just keys) that were not operated on due to some error. If set to false, the list of vserver-motd objects not operated on will not be returned. Default: true
If set to true, the API will return the list of vserver-motd objects (just keys) that were successfully operated on. If set to false, the list of vserver-motd objects operated on will not be returned. Default: true
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Information about vserver-motd objects that were not operated on due to some error. This element will be returned only if input element 'return-failure-list' is true.
Tag for the next call. Not present when there are no more matching vserver-motd objects to be operated on.
The number of vserver-motd objects that matched the query, but were not operated on due some error.
The number of vserver-motd objects that matched the query and were successfully processed.
The vserver-motd objects that were successfully processed. This element will be returned only if input element 'return-success-list' is true.vserver_protect_precheck
Specifies Uuid of the peer Cluster.
Vserver
Vserver UUID
was the precheck successful
Validation Error Codesvserver_protect_precheck_dp_support
Specifies Uuid of the peer Cluster.
was the precheck successfulvserver_protect_precheck_network
Specifies Uuid of the peer Cluster.
IPsapce of the destination vserver
Peer cluster UUID
Vserver
Vserver UUID
vserver_protect_precheck_vge_support
Specifies Uuid of the peer Cluster.
was the precheck successfulvserver_remove_aggregates
Specifies a list of aggregates to be removed from Vserver.
Specifies the name of the Vserver from which aggregates are to be removed.
vserver_remove_protocols
Is the list of protocols to be removed from the vserver specified. Possible values are: 'nfs', 'cifs', 'fcp', 'iscsi', and 'ndmp'.
Specifies the name of the Vserver on which the given set of protocols are not allowed.
vserver_rename
New Vserver name (Use Fully Qualified Domain Name, For example: data.example.com)
Vserver
vserver_rename_async
New Vserver name (Use Fully Qualified Domain Name, For example: data.example.com)
Vserver
Error code, if the operation caused an error.
Error description, if the operation caused an error.
Job Id, if this operation was performed via a job.
The operation status. Possible values: "succeeded", "in_progress", "failed".vserver_san_purge
vserver_san_purge_verify
SAN Kernel Agent for the Vserver is unloaded or notvserver_show_aggr_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver show-aggregates object. All vserver show-aggregates objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Vserver
The list of attributes of vserver show-aggregates objects.
Tag for the next call. Not present when there are no more vserver show-aggregates objects to return.
The number of records returned in this call.vserver_start
In case of a MetroCluster configuration or Vserver disaster recovery, by using this parameter you can start a Vserver when it is locked (which prevents any configuration changes) or when its partner Vserver is operationally running. The default value for this parameter is false.
Specifies the name of the Vserver to be started.
vserver_stop
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. The following restrictions are applicable for the Vserver name: - Maximum number of characters supported is 47, and 41 for a Vserver with subtype 'sync-source' - 'all' is a reserved name and should not be used as a Vserver name
vserver_unlock
Force unlock the Vserver which got locked as part of a DR event or an error condition. The default value for this parameter is false.
Specifies the name of the Vserver to be unlocked.
vserver_migrate_cleanup
Vserver Name
vserver_migrate_cutover
Vserver Name
vserver_migrate_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Vserver Name
The attributes of the vserver-migrate.vserver_migrate_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-migrate object. All vserver-migrate objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-migrate objects.
Tag for the next call. Not present when there are no more vserver-migrate objects to return.
The number of records returned in this call.vserver_migrate_pause
Vserver Name
vserver_migrate_resume
Automatically cutover when ready
Transfer duration for marking ready for cutover (seconds)
Force flag for continuing with disruptive migrate
Skip checking iops requirement of volume on destination aggregates
Vserver Name
vserver_migrate_start
Aggregate list
Automatically cutover when ready
Check if migrate can be done
Transfer duration for marking ready for cutover (seconds)
Force flag for continuing with disruptive migrate
Destination cluster IPspace Name for vserver
Skip checking iops requirement of volume on destination aggregates
Source Cluster Name
Vserver Name
vserver_migrate_volume_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Volume Name
Vserver Name
The attributes of the vserver-migrate-volume.vserver_migrate_volume_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-migrate-volume object. All vserver-migrate-volume objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-migrate-volume objects.
Tag for the next call. Not present when there are no more vserver-migrate-volume objects to return.
The number of records returned in this call.vserver_peer_accept
Specifies local name of the peer Vserver in the relationship.
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_check_peer_table
Want to send EMS
vserver_peer_create
Applications which can make use of the peering relationship. Possible values: 'snapmirror', 'file_copy', 'lun_copy', 'flexcache'.
Specifies local name of the peer Vserver in the relationship.
Specifies name of the peer Cluster. If peer Cluster is not given, it considers local Cluster.
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_delete
Force Delete
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Specifies name of the peer Vserver in the relationship
The attributes of the vserver-peer.vserver_peer_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-peer object. All vserver-peer objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-peer objects.
Tag for the next call. Not present when there are no more vserver-peer objects to return.
The number of records returned in this call.vserver_peer_modify
Applications which can make use of the peering relationship. Possible values: 'snapmirror', 'file_copy', 'lun_copy', 'flexcache'.
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_modify_local_name
Remote Peer Vserver Local Name
Peer Cluster
Remote Peer Vserver
vserver_peer_permission_create
Peering Applications Possible values:
Specifies name of the peer Cluster.
Specifies name of the local Vserver. Use symbol * to denote a permission that applies for all local Vservers.
vserver_peer_permission_delete
Specifies name of the peer Cluster.
Specifies name of the local Vserver. Use symbol * to denote a permission that applies for all local Vservers.
vserver_peer_permission_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Specifies name of the peer Cluster.
Specifies name of the local Vserver. Use symbol * to denote a permission that applies for all local Vservers.
The attributes of the vserver-peer-permission.vserver_peer_permission_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-peer-permission object. All vserver-peer-permission objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-peer-permission objects.
Tag for the next call. Not present when there are no more vserver-peer-permission objects to return.
The number of records returned in this call.vserver_peer_permission_modify
Peering Applications Possible values:
Specifies name of the peer Cluster.
Specifies name of the local Vserver. Use symbol * to denote a permission that applies for all local Vservers.
vserver_peer_reject
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_repair_peer_name
vserver
vserver_peer_resume
Force Resume
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_suspend
Force Suspend
Specifies name of the peer Vserver in the relationship
Specifies name of the local Vserver in the relationship
vserver_peer_transition_create
List of Local LIFs
Local Vserver name
Additional address for source 7-Mode system
If set to true, returns the vserver-peer-transition on successful creation. Default: false
Source 7-Mode system
The vserver-peer-transition created (keys or the entire object if requested)vserver_peer_transition_destroy
Local Vserver name
Source 7-Mode system
vserver_peer_transition_destroy_iter
This input element is useful when multiple vserver-peer-transition objects match a given query. If set to true, the API will continue deleting the next matching vserver-peer-transition even when the deletion of a previous vserver-peer-transition fails. If set to false, the API will return on the first failure. Default: false
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching vserver-peer-transition even when the deletion of a previous matching vserver-peer-transition fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
The maximum number of vserver-peer-transition objects to delete in this call. Default: 20
If deleting a specific vserver-peer-transition, this input element must specify all keys. If deleting multiple vserver-peer-transition objects based on query, this input element must specify a query.
If set to true, the API will return the list of vserver-peer-transition objects (just keys) that were not deleted due to some error. If set to false, the list of vserver-peer-transition objects not deleted will not be returned. Default: true
If set to true, the API will return the list of vserver-peer-transition objects (just keys) that were successfully deleted. If set to false, the list of vserver-peer-transition objects deleted will not be returned. Default: true
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
Information about vserver-peer-transition objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
Tag for the next call. Not present when there are no more matching vserver-peer-transition objects to be deleted.
Number of vserver-peer-transition objects that matched the query, but were not deleted due to some error.
The number of vserver-peer-transition objects that matched the query and were successfully deleted.
The vserver-peer-transition objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is truevserver_peer_transition_get
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
Local Vserver name
Source 7-Mode system
The attributes of the vserver-peer-transition.vserver_peer_transition_get_iter
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
The maximum number of records to return in this call. Default: 20
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-peer-transition object. All vserver-peer-transition objects matching this query up to 'max-records' will be returned.
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
The list of attributes of vserver-peer-transition objects.
Tag for the next call. Not present when there are no more vserver-peer-transition objects to return.
The number of records returned in this call.vserver_peer_transition_modify
List of Local LIFs
Local Vserver name
Additional address for source 7-Mode system
Source 7-Mode system
wafl_get_sync_status
Handle representing a previously issued wafl-sync operation.
Status information about the previous CP request on volume. Possible values:
wafl_sync
A list of volume names to take a CP on. In Data ONTAP 7-Mode, the CP operation will be performed on all the volumes on the controller if no volumes are specified. In Data ONTAP Cluster-Mode, "volumes" is a required input and all specified volumes must belong to the same Vserver. If an error is encountered when processing the sync request for a volume, the operation is aborted and sync operation will not be performed on the rest of the volumes specified.
List of handles to be used to query the sync status using 'wafl-get-sync-status' ZAPI.
TYPEDEFS
active-directory-account-config
Active Directory configuration information for the Vserver. When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Active Directory account NetBIOS name. Attributes: required-for-create, non-modifiable
Fully qualified domain name. Attributes: required-for-create, modifiable
NetBios domain/workgroup name. Attributes: non-creatable, non-modifiable
Organizational unit under which the Active Directory account resides. Attributes: optional-for-create, non-modifiable
Vserver Attributes: key, non-creatable, non-modifiabledomain-name
The domain name is an identification label that defines a realm based on Domain Name Service (DNS).
netbios-name
Name of a client or a server participating in a NetBIOS Windows File sharing service network. This can be different from the host name.
aggr-64bit-upgrade-attributes
Information related to 64-bit upgrade.
Information returned when upgrade-64bit-mode input in aggr-add API is "check".
Information returned when upgrade-64bit-mode in aggr-add API is "grow_all", "grow_none", or "grow_reserved".
Status information related to 64-bit upgrade. This information includes whether the 64-bit upgrade is in progress.aggr-attributes
Attributes of an aggregate. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
Information related to 64-bit upgrade. After 64-bit upgrade completes, this information is no longer available.
This field contains file system related information about the aggregate. This information will not be returned for a striped aggregate.
This field contains inode related information about the aggregate. This information will not be returned for a striped aggregate.
This field contains ownership related information about the aggregate. This information will not be returned for a striped aggregate.
This field contains performance related informtaion about the aggregate.
This field contains RAID specific information of the aggregate
This field contains snaplock specific information of the aggregate
This field contains snapMirror specific information of the aggregate This information will not be returned for a striped aggregate.
This field contains snapshot specific information of the aggregate. This information will not be returned for a striped aggregate.
This field contains space specific information of the aggregate
This field contains striping specific information of the aggregate This information is returned only if aggregate is striped.
This field contains various counts information of volume in the aggregate.
This field contains wafliron specific information of the aggregate
Name of the aggregate.
Aggregate's Universal Unique IDentifier. UUIDs are 16-byte quantities that are typically displayed as having five hexadecimal fields separated by hyphens. For example: d2da3566-da53-11d7-a841-000100000529
The threshold when an aggregate is considered balanced by the Auto Balance Aggregate feature.
The state of the aggregate being balanced. Possible values:
The states excluded, balanced and unbalanced are available only when Auto Balance Aggregate is enabled.
The number of times an aggregate has been transitioned from balanced to unbalanced and vice-versa.
The threshold when an aggregate is considered unbalanced by the Auto Balance Aggregate feature.
When set to 'true', the aggregate is excluded from Auto Balance aggregate processing. When set to 'false' the aggregate is included in Auto Balance Aggregate processing.
When set to 'true', the aggregate is included in Auto Balance aggregate processing. When set to 'false' the aggregate is excluded from Auto Balance Aggregate processing.
When set to 'true', the aggregate is a 7-mode transitioned aggregate in pre-commit phase.
"true" if the inactive data reporting is enabled on an aggregate, "false" otherwise.
When set to 'true', the aggregate is is eligible to have an object store attached to it.
When set to 'true', the aggregate is a 7-mode transitioned aggregate that is not yet committed on C-mode, and is currently out of space.
List of node names. If aggregate-name is also specified, then the matching aggregate on given nodes is returned. If not, all aggregates on specified nodes are returned. If this element is omitted when the request is sent to the Admin Vserver LIF, then all matching aggregates in the cluster are returned.
Specifies the striping information about the aggregate. Possible values are "not_striped", "striped", and "unknown"aggr-autobalance-aggregate-state
State related to each aggregate monitored by Auto Balance Aggregate. When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Name of the aggregate.
Threshold used by AutoBalance aggregate to determine if an aggregate is eligible for balancing, in bytes.
Size of volumes that are moving towards the aggregate, in bytes.
Indicates if the aggregate should be balanced.
Indicates if the aggregate should be considered for balancing.
Is a hybrid aggregate.
Node the aggregate resides on.
Size of volumes that are moving away from the aggregate, in bytes.
RAID type of the aggregate.
Total size of the aggregate in bytes.
Used size of the aggregate in bytes.aggr-autobalance-config
Configuration of Auto Balance Aggregate When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
When Auto Balance Aggregate identifies an aggregate that needs to be balanced, it will attempt to identify other target aggregates it can move volumes to. An aggregate will only be considered as a target if its projected space usage after the move is still under this percentage. Auto Balance Aggregate will attempt to move volumes from an unbalanced aggregate until it is under this percentage. The default value is 40%.
This value represents the number of seconds that need to have elapsed since the volume was last moved before it will be considered a movable candidate again. The default value is 48 hours.
'true' if Auto Balance Aggregate is enabled. 'false' if Auto Balance Aggregate is disabled.
For all modes, Auto Balance Aggregate will identify the volume moves that will help to balance space usage across the aggregates. The mode dictates what Auto Balance Aggregate will do with the suggested moves. In 'recommend' mode, the suggested moves will be displayed, but no further action will be taken .In 'auto' mode, Auto Balance Aggregate will trigger moves to start. The default mode is 'recommend'.
Polling period, in seconds, used by Auto Balance Aggregate to update volume and aggregate state. The default value is 3600 seconds.
This percentage will indicate the space used threshold that will cause Auto Balance Aggregate to consider this aggregate as unbalanced. The default value is 60%.
The threshold, in number of operations per second preformed on a volume (read/write/internal), that will disqualify the volume from being a candidate to be moved by Auto Balance Aggregate. The default value is 100 operations per second.
This value represents a duration in seconds and designates the amount of time that has to elapse after a volume has exceeded the volume-activity-threshold before it can be considered a movable volume by Auto Balance Aggregate. The default value is 24 hours. aggr-autobalance-notification
Notifications for nodes that need to be balanced. When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The node that contains the aggregate which is considered a candidate for Auto Balance Aggregate. aggr-autobalance-volume-state
The state related to each volume monitored by Auto Balance Aggregate. When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The aggregate that contains the volume.
The dsid of the volume.
Indicates if volume is currently moving.
Indicates if volume is currently quiesced.
Timestamp related to when we exceeded the threshold of operations for the volume.
Timestamp related to when the volume was last moved.
The node the volume resides on.
The name of the volume.
Total size of the volume, in bytes.aggr-check-attributes
Information returned when upgrade-64bit-mode in aggr-add API is "check".
The effective total space that would be added (in bytes) to the aggregate. This would not include the blocks used by the 64-bit upgrade of the aggregate and its contained flexible volumes. Range: [0..2^64-1].
The error code of the last attempt to check for space usage on the specific aggregate. This field is present only if a previous 64-bit upgrade check failed. Possible values: 0 - indicates success EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL Per-volume upgrade check results may be out of date if last-errno is not 0.
The opaque cookie to uniquely identify a 64-bit upgrade transaction previously triggered on the aggregate using aggr-add API. Range: [0..2^64-1].
True if the space estimate has completed. Check "check-last-errno" to find out whether the space estimate was successful.aggr-disk-info
Information about the disks
This field indicates the percentage of copying that has completed. Attributes: non-creatable, non-modifiable
Name of the disk. Attributes: key, non-creatable, non-modifiable
Rotational speed in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. Omitted if information is unavailable, or if the rpm does not apply to this 'disk-type'. Attributes: non-creatable, non-modifiable
Disk interface type. Attributes: non-creatable, non-modifiable
Effective rotational speed in revolutions per minute. Disks can report different actual 'rpm', but have the same 'effective-disk-rpm'. Disks with the same 'effective-disk-rpm' are compatible for use within the same aggregate. Omitted if information is unavailable, or excluded by 'desired-attributes'. Attributes: non-creatable, non-modifiable
Effective disk interface type. Disk can report different physical 'disk-type', but the same 'effective-disk-type'. Disk with the same 'effective-disk-type' are compatible for use within the same aggregate. Attributes: non-creatable, non-modifiable
True if the disk is being used as cache. Attributes: non-creatable, non-modifiable
True if the disk is being evacuated. Attributes: non-creatable, non-modifiable
True if the disk is marked as offline. Attributes: non-creatable, non-modifiable
True if reconstruction is active on this disk. Attributes: non-creatable, non-modifiable
True if the disk is being replaced. Attributes: non-creatable, non-modifiable
True if the sick disk copy is active. Attributes: non-creatable, non-modifiable
True if the disk is marked as sick. Attributes: non-creatable, non-modifiable
Total raw capacity of this disk in bytes. Attributes: non-creatable, non-modifiable
Position of the disk within aggregate. Attributes: non-creatable, non-modifiable
This field indicates the percentage of reconstruction that has completed. Attributes: non-creatable, non-modifiable
Industry standard disk type. Attributes: non-creatable, non-modifiable Possible values:
Syncmirror Pool to which disk is assigned. Attributes: non-creatable, non-modifiable
Total usable capacity of this disk in bytes. Attributes: non-creatable, non-modifiableaggr-efficiency-additional-details-info
Additional details related to storage efficiency in this aggregate.
Number of volumes that are offline in the aggregate. Attributes: non-creatable, non-modifiable
Number of volumes on which efficiency change log is disabled in the aggregate. Attributes: non-creatable, non-modifiable
Number of volumes on which volume efficiency is disabled in the aggregate. Attributes: non-creatable, non-modifiableaggr-efficiency-aggr-info
Storage efficiency achieved at the aggregate level using techniques like data compaction.
The total disk space that is saved by data compaction and cross volume sharing at the aggregate level. Attributes: non-creatable, non-modifiable
Storage efficiency ratio of the aggregate. Attributes: non-creatable, non-modifiable
This contains logical size used by the aggregate. Attributes: non-creatable, non-modifiable
This contains physical size used by the aggregate. Attributes: non-creatable, non-modifiableaggr-efficiency-cumulated-additional-details-info
Additional details related to storage efficiency in the given aggregates.
Number of volumes that are offline in the given aggregates. Attributes: non-creatable, non-modifiable
Number of volumes on which efficiency change log is disabled in the given aggregates. Attributes: non-creatable, non-modifiable
Number of volumes on which volume efficiency is disabled in the given aggregates. Attributes: non-creatable, non-modifiable
Number of Skipped aggregates. Attributes: non-creatable, non-modifiable
List of Aggregates skipped Attributes: non-creatable, non-modifiableaggr-efficiency-cumulated-aggr-info
Storage efficiency achieved at the aggregate level using techniques like data compaction.
Storage efficiency ratio of the given aggregates. Attributes: non-creatable, non-modifiable
This contains logical size used by the given Aggregates. Attributes: non-creatable, non-modifiable
This contains physical size used by the given Aggregates. Attributes: non-creatable, non-modifiableaggr-efficiency-cumulated-info
Aggregate Storage Efficiency Information When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Additional details related to storage efficiency in the given aggregates.
Storage efficiency achieved at the aggregate level using techniques like data compaction.
Aggregated information of storage efficiency of Snapshot copies and FlexClone volumes in the given aggregates.
Aggregated information of storage efficiency achieved at the volume level using techniques like deduplication, compression, zero detection and FlexClones for files or LUNs.
cumulated storage efficiency information from the given aggregates.aggr-efficiency-cumulated-snapshot-and-flexclone-info
Aggregated information of storage efficiency of Snapshot copies and FlexClone volumes in the given aggregates.
Flexclone volume data reduction efficiency ratio of the given aggregates. Attributes: non-creatable, non-modifiable
This contains logical size used by all FlexClone volumes residing in the given aggregates. Attributes: non-creatable, non-modifiable
This contains physical size used by all FlexClone volumes in the given aggregates. Attributes: non-creatable, non-modifiable
Snapshot and FlexClone volume storage efficiency ratio of the given aggregates. Attributes: non-creatable, non-modifiable
This contains logical size used by all volume Snapshot copies residing in the given aggregates. Attributes: non-creatable, non-modifiable
This contains physical size used by all volume Snapshot copies residing in the given aggregates. Attributes: non-creatable, non-modifiable
Snapshot volume data reduction efficiency ratio of the given aggregates. Attributes: non-creatable, non-modifiableaggr-efficiency-cumulated-volume-info
Aggregated information of storage efficiency achieved at the volume level using techniques like deduplication, compression, zero detection and FlexClones for files or LUNs.
The total disk space that is saved by compressing blocks by all volumes in the given aggregates. Attributes: non-creatable, non-modifiable
Storage efficiency ratio of all the volumes in the given aggregates. Attributes: non-creatable, non-modifiable
The total disk space that is saved by volume Deduplication and pattern detection by all the volumes in the given aggregates. Attributes: non-creatable, non-modifiable
This contains logical size used by all the volumes in the given aggregates. Attributes: non-creatable, non-modifiable
This contains physical size used by all volumes in the given aggregates. Attributes: non-creatable, non-modifiableaggr-efficiency-cumulative-info
Cumulative storage efficiency information of an aggregate.
total data reduction efficiency ratio. Attributes: non-creatable, non-modifiable
Total Data reduction logical used excluding snapshot copies in the aggregate. Attributes: non-creatable, non-modifiable
Total Data reduction physical used excluding snapshot copies in the aggregate. Attributes: non-creatable, non-modifiable
This contains logical size used in the aggregate. This includes Volumes, Clones and Snapshots in the aggregate. The logical size is computed based on physical usage and savings obatained in the aggregate. Attributes: non-creatable, non-modifiable
This contains the physical size used by the aggregate. Attributes: non-creatable, non-modifiable
Total storage efficiency ratio of the aggregate. Attributes: non-creatable, non-modifiableaggr-efficiency-info
Aggregate Storage Efficiency Information When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Additional details related to storage efficiency in this aggregate.
Storage efficiency achieved at the aggregate level using techniques like data compaction.
Cumulative storage efficiency information of an aggregate.
Aggregated information of storage efficiency of Snapshots and FlexClone volumes in the aggregate.
Aggregated information of storage efficiency achieved at the volume level using techniques like deduplication, compression, zero detection and FlexClones for files or LUNs.
Name of the aggregate. Attributes: key, non-creatable, non-modifiable
Name of the node where the aggregate resides. Attributes: non-creatable, non-modifiableaggr-efficiency-snapshot-and-flexclone-volume-info
Aggregated information of storage efficiency of Snapshots and FlexClone volumes in the aggregate.
This contains logical size used by all FlexClone volumes residing in the aggregate. Attributes: non-creatable, non-modifiable
This contains physical size used by all FlexClone volumes in the aggregate. Attributes: non-creatable, non-modifiable
Snapshot and FlexClone volume storage efficiency ratio of the aggregate. Attributes: non-creatable, non-modifiable
This contains logical size used by all Volume Snapshots residing in the aggregate. Attributes: non-creatable, non-modifiable
This contains physical size used by all Volume Snapshots residing in the aggregate. Attributes: non-creatable, non-modifiableaggr-efficiency-total-cumulated-info
cumulated storage efficiency information from the given aggregates.
Total data reduction efficiency ratio of the given aggregates. Attributes: non-creatable, non-modifiable
Total data reduction logical used excludes snapshot copies. Attributes: non-creatable, non-modifiable
Total data reduction physical used excludes snapshot copies. Attributes: non-creatable, non-modifiable
This contains logical size used in the given aggregates. This includes volumes, clones and Snapshot copies in the given aggregates. The logical size is computed based on physical usage and savings obatained in the given aggregates. Attributes: non-creatable, non-modifiable
This contains the physical size used by the given aggregates. Attributes: non-creatable, non-modifiable
Total storage efficiency ratio of the given aggregates. Attributes: non-creatable, non-modifiableaggr-efficiency-volume-info
Aggregated information of storage efficiency achieved at the volume level using techniques like deduplication, compression, zero detection and FlexClones for files or LUNs.
The total disk space that is saved by compressing blocks by all volumes in the aggregate. Attributes: non-creatable, non-modifiable
Storage efficiency ratio of all the volumes in the aggregate. Attributes: non-creatable, non-modifiable
The total disk space that is saved by deduplication and FlexClone for files or LUNs by all volumes in the aggregate. Attributes: non-creatable, non-modifiable
This contains logical size used by all the volumes in the aggregate. Attributes: non-creatable, non-modifiable
This contains physical size used by all volumes in the aggregate. Attributes: non-creatable, non-modifiable
The total disk space that is saved by inline zero pattern detection by all the volumes in the aggregate. Attributes: non-creatable, non-modifiableaggr-fs-attributes
File system specific information about the aggregate.
The indirect block format that the aggregate can have. The default is 64_bit. With a 64_bit block-type creation of aggregates that can be larger than 16TB is allowed. Possible values: 64_bit
Aggregate's File System Identifier.
The type of aggregate. Possible values: aggr "aggr" (for aggregates that can contain flexible volumes)aggr-inode-attributes
A structure returning inode-related information for a given aggregate's Active File System (AFS).
[not settable, online-only] Number of system (not user-visible) files (inodes) used. If the referenced file system is restricted or offline, a value of 0 is returned.
[settable, online-only] Total user-visible file (inode) count, i.e., maximum number of user-visible files (inodes) that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] Number of user-visible files (inodes) used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created.
[not settable, online-only] Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created.
[not settable, online-only] The inofile-version of the aggregate. If the referenced aggregate is restricted or offline, then a value of 0 is returned.
[not settable, always] The count of the maximum number of user-visible files currently allowable on the referenced file system.
[not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system.
[not settable, online-only] The number of user-visible files currently in use on the referenced file system.
[not settable, online-only] The percentage of disk space currently in use based on user-visible file (inode) count on the referenced file system.aggr-object-store-config-info
Object Store Info When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Access key ID for AWS_S3 and SGWS provider types Attributes: optional-for-create, modifiable
Authentication used to access the object store. Supported values are:
Attributes: optional-for-create, modifiable
Azure account Attributes: optional-for-create, non-modifiable
URL to request temporary credentials for a C2S account. Attributes: optional-for-create, modifiable
IPspace to use in order to reach the object store. Attributes: optional-for-create, modifiable
Is SSL/TLS certificate validation enabled. The default value is 'true'. Attributes: optional-for-create, modifiable
Percentage of the object store's total licensed capacity used by this config. This field is not returned for Cloud Volumes ONTAP. Attributes: non-creatable, non-modifiable
Name for the object store configuration to be created. The name can contain letters, numbers, and the underscore character (_), but the first character must be a letter or an underscore. Attributes: key, required-for-create, non-modifiable
UUID of the object store configuration Attributes: non-creatable, non-modifiable
Port number of the object store Attributes: optional-for-create, modifiable
Type of object store provider. Allowed values are:
Attributes: required-for-create, non-modifiable
Data bucket/container name Attributes: required-for-create, non-modifiable
Fully qualified domain name of the object store Attributes: required-for-create, modifiable
SSL/HTTPS enabled or not. The default value is 'true'. Attributes: optional-for-create, modifiable
Capacity used in the object store by this config. Attributes: non-creatable, non-modifiableaggr-option-info
Option key and value. The possible values are described in the "aggr-set-option" API below.
Option key.
Option value.aggr-ownership-attributes
Ownership information about the aggregate.
Name of the cluster which has the node that owns this aggregate.
NVRAM ID of the DR (disaster recovery) node to which this aggregate's disks have been administratively assigned. This information is derived from the sanown information for an aggregate's disks. See 'disk-sanown-detail-info'
Name of the DR node to which this aggregate's disks have been administratively assigned.
NVRAM ID of the node to which this aggregate's disks have been administratively assigned. This information is derived from the sanown information for an aggregate's disks. See 'disk-sanown-detail-info'
Name of the node to which this aggregate's disks have been administratively assigned.
NVRAM ID of node to which the aggregate ownership has been assigned. Normally, home-id matches owner-id. But these may be changed by SFO takeover to match the takeover node, and restored by SFO giveback to match home-id. CFO takeover and giveback do not affect owner-id.
Name of node to which the aggregate ownership has been assigned. Normally, home-name matches owner-name. But these may be changed by SFO takeover to match the takeover node, and restored by SFO giveback to match home-name. CFO takeover and giveback do not affect owner-name.aggr-performance-attributes
Performance specific attributes of the aggregate
Returns the free space reallocation state of the aggregate. Possible values : "on", "off", "no_redirect"
The default value is "off"
The maximum number of blocks used for write allocation. Some sequential read workloads may benefit from increasing this value. Default value is 0 which uses the controller-wide default value of 64. The default is optimal for most users. The controller-wide default can be adjusted with the bootarg "wafl-max-write-alloc-blocks"
Indicates if Single Instance Data Logging is enabled on the aggregate. This feature is supported only on Cloud ONTAP. Possible values : "on", "off"
The default value is "off"aggr-plex-info
Information about the Plex
True if plex is online. Attributes: non-creatable, non-modifiable
True if plex is resyncing. Attributes: non-creatable, non-modifiable
Name of the plex. Attributes: key, non-creatable, non-modifiable
Syncmirror Pool associated with the plex. Attributes: non-creatable, non-modifiable
If plex-is-resyncing is true, this field indicates the resync level of the plex. Attributes: non-creatable, non-modifiable
This field indicates percentage of resync that has completed, rounded down to two decimal places. Attributes: non-creatable, non-modifiable
This field indicates the percentage of resync that has completed. Attributes: non-creatable, non-modifiable
Status of the plex. Attributes: non-creatable, non-modifiableaggr-raid-attributes
RAID specific information of the aggregate
Type of aggregate. The possible values:
Current maximum cache RAID group size of hybrid aggregate. RAID group size is the maximum number of disks that can be added to a RAID group. This information will only be returned for a hybrid aggregate i.e. whose "is-hybrid" field is set to true.
Checksum status. Possible values: "active", "initializing", "none", "off", "reinitialized", "reinitializing", "reverting", "unknown", "upgrading_phase1", "upgrading_phase2" This information will not be returned for a striped aggregate.
Checksum style. The possible values:
Number of disks in the aggregate.
If true, returns aggregates supporting encryption with aggregate key.
Supplies the 64-byte encryption key ID associated with the encrypted aggregates, for example 40004FE3000000000303000000000000436F5DB53445FD603FB5A8A64937AA7B
Aggregate's HA policy. Possible return values: "cfo", "sfo", "none"
Whether the aggregate contains the local root volume. This information will not be returned for a striped aggregate. Default value is false.
Whether the aggregate contains the partner's root volume. This information will not be returned for a striped aggregate. Default value is false.
Is checksumming enabled for the aggregate? Default value is false.
If true, aggregate currently contains two tiers of storage.
If true, returns only encrypted aggregates.
If true, aggregate currently contains both SSD and non-SSD RAID groups.
If true, aggregate is eligible to contain both SSD and non-SSD RAID groups.
Whether or not the aggregate is inconsistent. Default value is false.
If true, the aggregate is mirrored. Default value is false.
If true, the aggregate is capable of supporting NVE.
Whether this is a root aggregate. Default value is false. This differs from has-local-root and has-partner-root by evaluating true when the aggregate may contain a root volume for any node. The has-local-root and has-partner-root fields only evaluate true when the aggregate contains the active root for the specified node. The is-root-aggregate field will still evaluate true for an offline root aggregate. The has-local-root and has-partner-root fields will evaluate false, since the aggregate has no mounted filesystem.
Aggregate's mirror status. Possible values: "invalid", "uninitialized", "needs CP count check", "CP count check in progress", "unmirrored", "mirrored", "mirror degraded, "mirror resynchronizing", "failed", "limbo" and
[not settable, always] This field shows the volume's mount state. Possible values: "creating", "destroying", "frozen", "inconsistent", "iron_restricted", "mounting", "online", "quiescing", "quiesced", "reverted", "unmounted", "unmounting" This information will not be returned for a striped aggregate.
Number of plexes in the aggregate. This value tells us the size of the returned "plex" array.
List of plexes in the aggregate
State of the RAID Lost Write feature for an aggregate. The possible values are:
Current RAID group size. This information will not be returned for a striped aggregate.
RAID status. Possible values: "copying", "degraded", "foreign", "growing", "hybrid", "hybrid_enabled", "initializing", "invalid", "ironing", "mirror degraded", "mixed_raid_type", "mirrored", "needs check", "normal", "noparity", "out-of-date", "parity uninit'd", "partial", "raid0", "raid4", "raid_dp", "raid_tec", "reconstruct", "resyncing", "verifying". These values may appear by themselves or in combination separated by commas (e.g., "mixed_raid_type, hybrid, normal"). For details on raid-type, refer description of element 'raid-type' below
Possible values:
Aggregate State Possible values:
If true, aggregate is using shared disks.aggr-raidgroup-entity-info
Information about the individual RAID Groups
True if the RAID Group is recomputing parity. Attributes: non-creatable, non-modifiable
True if the RAID Group is reconstructing. Attributes: non-creatable, non-modifiable
This field indicates if scrub is currently active. Attributes: non-creatable, non-modifiable
Name of the Raid Group. Attributes: key, non-creatable, non-modifiable
Checksum Style of RAID Group. Attributes: non-creatable, non-modifiable
RAID Type of RAID Group. Attributes: non-creatable, non-modifiable
This field indicates the percentage of reconstruction that has completed. Attributes: non-creatable, non-modifiable
This field indicates the percentage of parity recomputation that has completed. Attributes: non-creatable, non-modifiable
Status of the RAID Group. Attributes: non-creatable, non-modifiable
This field indicates the percentage of scrubbing that has completed. Attributes: non-creatable, non-modifiableaggr-raidgroup-info
Information about the RAID Groups
Information about the individual RAID Groups
Name of the Storage Pool. Attributes: non-creatable, non-modifiableaggr-relocation-info
Aggregate Information When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
Aggregate Name Attributes: non-creatable, non-modifiable
Destination for Relocation Attributes: non-creatable, non-modifiable
Aggregates Relocation Status Attributes: non-creatable, non-modifiable Possible values include:
Name of the source node in which aggregate resides Attributes: key, non-creatable, non-modifiableaggr-resync-options-info
Aggregate resynchronization options info When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The number of aggregates, owned by the specified node, that are allowed to resync at a time Attributes: non-creatable, modifiable
Name of the node for which the resynchronization option is defined Attributes: key, non-creatable, non-modifiableaggr-snaplock-attributes
Snaplock specific information of the aggregate
Whether or not it's a SnapLock aggregate.
The type of the snaplock aggregate. Possible values - "compliance" or "enterprise" or "non-snaplock"aggr-snapmirror-attributes
SnapMirror specific information of the aggregate
When present, this field indicates the number of data protection (dp) snapmirror destination volumes.
When present, this field indicates the number of load sharing (ls) snapmirror destination volumes.
When present, this field indicates the number of move snapmirror destination volumes that are created for volume move operations.aggr-snapshot-attributes
A structure returning consolidated size-related information for all snapshots of the given aggregate.
[settable, online-only] Total file (inode) count, i.e., current maximum number of files (inodes) that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] Number of files (inodes) used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] The inofile-version on the referenced file system. A value of 0 is returned if the referenced file system is restricted or offline.
This option determines if auto snapshot is enabled on the aggregate. Default value is true.
This option determines if the snapshot auto delete is currently enabled for the aggregate. Default value is true.
[not settable, always] The count of the maximum number of files allowable on the referenced file system.
[not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system.
[not settable, online-only] The count of the number of files currently in use on the referenced file system.
[not settable, online-only] The percentage of disk space currently in use based on file (inode) count on the referenced file system.
[not settable, online-only] The percentage of disk space currently in use on the referenced file system.
[not settable, online-only] Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] Total size (in bytes) of the referenced file system. If the referenced file system is restricted or offline, a value 0 is returned.
[not settable, online-only] Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
The percentage of aggregate disk space that has been set aside as reserve for snapshot usage. Default value is 0.aggr-space-attributes
A structure returning space-related information for a given aggregate's Active File System (AFS).
This field is deprecated in Data ONTAP 8.3 and later. Use the aggregate-metadata field of aggr-space-get-iter instead. This field always returns 0. Range : [0..2^64-1]
This field represents total capacity tier physical used space in bytes in a composite aggregate. Range : [0..2^64-1]
The total physical disk footprint of the compacted data blocks in the referenced file system. Range : [0..2^64-1]
The total disk space saved due to Data Compaction in the referenced file system. Range : [0..2^64-1]
The percentage of the used space in the referenced file system that has been saved by Data Compaction. Range : [0..100]
[not settable, online-only] Total cache size (in bytes) in a hybrid aggregate. If the referenced aggregate is restricted or offline, or if it is not a hybrid aggregate, a value of 0 is returned.
[not settable, online-only] The percentage of disk space currently in use on the referenced file system.
The amount of inactive user data in bytes. Range : [0..2^64-1]
The percentage of the used space in the referenced file system that is inactive user data. Range : [0..100]
This field represents physical used space in bytes. This differs from 'total-used' space by the space that is guaranteed for future writes. The value includes blocks in use by Snapshot copies. Range : [0..2^64-1]
This field represents physical used space in percent. Range : [0..2^64-1]
The total physical disk footprint of the shared data blocks in the referenced file system achived by data compation and cross-volume inline deduplication. Range : [0..2^64-1]
The total disk space saved due to Data Compaction and cross-volume inline deduplication in the referenced file system. Range : [0..2^64-1]
The percentage of the used space in the referenced file system that has been saved by Data Compaction and cross-volume inline deduplication. Range : [0..100]
[not settable, online-only] Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] Total size (in bytes) of the referenced file system . If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.
[not settable, online-only] The total disk space in bytes that is reserved on the referenced file system. The reserved space is already counted in the used space, so this element can be used to see what portion of the used space represents space reserved for future use.
This field is deprecated in Data ONTAP 8.3 and later. Use the used-including-snapshot-reserve field of aggr-space-get-iter instead. This field always returns 0. Range : [0..2^64-1]
This field is deprecated in Data ONTAP 8.3 and later. Use the volume-footprints field of aggr-space-get-iter instead. This field always returns 0. Range : [0..2^64-1]aggr-spare-disk-info
Spare disk Information When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
An indication of the checksum types that this disk is capable of supporting. Each possible return value represents one or more checksum types. Attributes: non-creatable, non-modifiable Possible values:
Name of the spare disk. Attributes: non-creatable, non-modifiable
Disk class. Disks are grouped into classes based on their performance characteristics. Disks with the same 'disk-class' value are compatible for use in the same aggregate. Attributes: non-creatable, non-modifiable Possible values:
Rotational speed in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. Omitted if information is unavailable, or if the rpm does not apply to this 'disk-type'. Attributes: non-creatable, non-modifiable
Disk interface type Attributes: non-creatable, non-modifiable Possible values:
Effective rotational speed in revolutions per minute. Disks can report different actual 'rpm', but have the same 'effective-disk-rpm'. Disks with the same 'effective-disk-rpm' are compatible for use within the same aggregate. Omitted if information is unavailable, or excluded by 'desired-attributes'. Attributes: non-creatable, non-modifiable
Effective disk interface type. Disk can report different physical 'disk-type', but the same 'effective-disk-type'. Disk with the same 'effective-disk-type' are compatible for use within the same aggregate. Attributes: non-creatable, non-modifiable Possible values:
True if disk is was left behind during giveback/switchback. Attributes: non-creatable, non-modifiable
True if disk is a shared disk. Attributes: non-creatable, non-modifiable
True if disk is pre-zeroed. Attributes: non-creatable, non-modifiable
True if disk is in process of being zeroed. Attributes: non-creatable, non-modifiable
True if disk is a sparecore disk. Attributes: non-creatable, non-modifiable
Usable spare capacity in bytes present in the data partition of this disk. This field is omitted
If the disk is a root-data1-data2 partitioned disk, both data partitions are assigned to the current node and are spare then this field is sum of usable capacity from both the data partitions. Attributes: non-creatable, non-modifiable
Usable spare capacity in number of 4K blocks present in the data partition of this disk. This field is omitted
If the disk is a root-data1-data2 partitioned disk, both data partitions are assigned to the current node and are spare then this field is sum of usable capacity from both the data partitions. Attributes: non-creatable, non-modifiable
Usable spare capacity in bytes present in the first data partition of this disk. This field is omitted
Attributes: non-creatable, non-modifiable
Usable spare capacity in number of 4K blocks present in the first data partition of this disk. This field is omitted
Attributes: non-creatable, non-modifiable
Usable spare capacity in bytes present in the second data partition of this disk. This field is omitted
Attributes: non-creatable, non-modifiable
Usable spare capacity in number of 4K blocks present in the second data partition of this disk. This field is omitted
Attributes: non-creatable, non-modifiable
Usable spare capacity in bytes present in the root partition of this disk. This field is omitted
Attributes: non-creatable, non-modifiable
Usable spare capacity in number of 4K blocks present in the root partition of this disk. This field is omitted
Attributes: non-creatable, non-modifiable
Node for which the spare information is returned. Attributes: key, non-creatable, non-modifiable
Industry standard disk type. Attributes: non-creatable, non-modifiable Possible values:
Syncmirror Pool to which disk is assigned Attributes: non-creatable, non-modifiable
Total raw capacity of this disk in bytes Attributes: non-creatable, non-modifiable
Total usable capacity of this disk in bytes Attributes: non-creatable, non-modifiable
Total usable capacity of this disk in number of 4K blocks Attributes: non-creatable, non-modifiable
If 'is-disk-zeroing' is true, this field indicates the percentage of zeroing that has completed. Attributes: non-creatable, non-modifiableaggr-start-attributes
Information returned when upgrade-64bit-mode in aggr-add API is "grow_all", "grow_none", or "grow_reserved".
The minimum additional disk space (in bytes) required to trigger 64-bit upgrade. This field is present when the specified disks do not have sufficient space to upgrade the aggregate and its contained flexible volumes to 64-bit. Range: [0..2^64-1].
The error code of the last attempt to start 64-bit upgrade on the specific aggregate. This field is present only if a previous 64-bit upgrade failed. Possible values include: EAGGR_64BIT_UPGRADE_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC_OVERWRITE EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL EVOLUME_64BIT_UPGRADE_PREQUAL_NOT_AVAILaggr-status-attributes
Status information related to 64-bit upgrade. This information includes whether the 64-bit upgrade is in progress.
True if the 64-bit upgrade is in progress.aggr-status-info
Aggregate Status & Topology Information When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Checksum Style of Aggregate. Attributes: non-creatable, non-modifiable
RAID Status of Aggregate. Attributes: non-creatable, non-modifiable
RAID Type of Aggregate. Attributes: non-creatable, non-modifiable
WAFL Status of Aggregate. Attributes: non-creatable, non-modifiable
Name of the aggregate. Attributes: key, non-creatable, non-modifiable
Aggregate's Universal Unique IDentifier. Attributes: non-creatable, non-modifiable
True if mirror verification is in progress Attributes: non-creatable, non-modifiable
This field indicates the percentage of mirror verification that has completed, rounded down to two decimal places. Attributes: non-creatable, non-modifiable
This field indicates the percentage of mirror verification that has completed. Attributes: non-creatable, non-modifiable
Node hosting the aggregate. Attributes: non-creatable, non-modifiableaggr-striping-attributes
Striping specific information of a striped aggregate This information will not be returned for the not-striped aggregate.
Number of members in a striped aggregate.aggr-volume-count-attributes
WAFL volume count specific information of the aggregate
Number of volumes in the aggregate.
Number of striped volume constituents in the aggregate which also represent a collective striped volume. This field is for internal use only.
When present, this field indicates the number of volumes that are not online (offline and restricted volumes).
When present, this field indicates the number of quiesced online volumes.
Number of striped volume constituents in the aggregate. These volumes are also reported in the full volume-count value. This field is for internal use only.aggr-wafliron-attributes
WAFL-iron specific information of the aggregate
The error code of the last attempt to start wafliron on the specific aggregate. This field is present only if 'wafliron start' was previously attempted.
The error information of the last attempt to start wafliron on the specific aggregate. This field is present only if 'wafliron start' was previously attempted.
When present, this field indicates the percentage of blocks that have been scanned in the specified aggregate. This field is present only when wafliron is running and its state is "starting" or "scanning".
When wafliron is run, it goes through different stages/states. This field indicates the current state of wafliron on the specified aggregate.
When present and the value is other than -1, this field indicates the percentage of summary blocks that have been scanned in the specified aggregate. This field is present only when wafliron is running and its state is "starting" or "scanning".aggregate-simulate-layout-info
The aggregate layout returned as a result of simulating an aggregate provisioning operation.
Estimated usable aggregate capacity (in bytes) in case of aggregate creation or mirroring operation. Estimated increase in usable aggregate capacity (in bytes) in case of aggregate addition operation.
The checksum types of the RAID groups the disks belong to. There is a one to one correspondence with the disk names. Possible values:
The physical sizes of disks selected for provisioning (in bytes). There is a one to one correspondence with the disk names.
The position of disks within the RAID groups. There is a one to one correspondence with the disk names. Possible values are:
The file system sizes of disks selected for provisioning (in bytes). There is a one to one correspondence with the disk names.
The disk type of the disks selected for provisioning. There is a one to one correspondence with the disk names. Possible values:
Names of disks that were returned when aggregate provisioning was simulated.
The RAID types of the RAID groups the disks belong to. There is a one to one correspondence with the disk names. Possible values:
The RAID groups that the disks returned by the aggregate provisioning simulation operation belong to. There is a one to one correspondence with the disk names. These are of the form "/autobalance-aggregate-state
Auto Balance Aggregate state Possible values:
checksum-style
Checksum style of the aggregate.
default-raidtype-config-info
Default RAID type for each disk size and disk type supported on this filer.
Name of the RAID type allowed on this filer. Possible values: raid0, raid4, raid_dp and raid_tec.
Name of the Disk type present on this controller. Possible values include FCAL, ATA, LUN, SAS, SSD, SSD_NVM, BSAS, FSAS, MSATA and VMDISK.
Maximum capacity (in TiB) of the disk for which the raid types are specified. This appears only for SATA family disks of size less than or equal to 4TiB. If this field is not present in output then there is no restriction on maximum disk capacity for given disk type. This will appear for SATA family disks and when the default RAID type is raid_dp.
Minimum capacity (in TiB) of the disk for which the raid types are specified. This appears only for SATA family disks of size greater than 4TiB. If this field is not present in output then there is no restriction on minimum disk capacity for given disk type. This will appear for SATA family disks and when the default RAID type is raid_tec.disk-info
Information for each disk in the plex.
Name of a member disk.
VBN end value of a disk.
VBN start value of a disk.disk-position-type
Disk position type of the aggregate.
min-aggr-disk-count-info
Minimum number of disks required in an aggregate of a specific RAID type.
Minimum disk count for the aggregate. Range : [1..7] Possible values:
Name of the RAID type allowed on this filer. Possible values: raid0, raid4, raid_dp, raid_tec.modify-raid-type-simulate-info
Information returned as a result of simulating the raid type modification.
Warnings from simulation of raid type modification. Possible warning codes are:
object-store-information
Object Store info When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Name of the aggregate. Attributes: key, non-creatable, non-modifiable
UUID of the aggregate. Attributes: non-creatable, non-modifiable
UUID of the capacity tier bin associated with the aggregate. Attributes: non-creatable, modifiable
Percentage of the object store's total licensed capacity used by this aggregate. This field is not returned for ONTAP Cloud. Attributes: non-creatable, non-modifiable
Availability of the object store. Attributes: non-creatable, non-modifiable Possible values:
Name of the object store configuration attached to the aggregate. Attributes: key, non-creatable, non-modifiable
UUID of the object store configuration attached to the aggregate. Attributes: non-creatable, non-modifiable
Type of object store provider. Allowed values are:
Attributes: non-creatable, modifiable
The maximum amount of space in the object store the aggregate can use. Attributes: non-creatable, modifiable
Percentage of space in the performance tier which must be used before data is tiered out to the capacity tier. Attributes: non-creatable, modifiable
Capacity used in the object store by this aggregate. Attributes: non-creatable, modifiableobject-store-vol-btuuids-info
Object Store Volume Buftree UUIDs Information When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Name of the aggregate. Attributes: key, non-creatable, non-modifiable
UUID of the capacity tier bin associated with the aggregate. Attributes: non-creatable, non-modifiable
Buftree UUID of the volume. Attributes: key, non-creatable, non-modifiable
Token uniquifier for the entry. Attributes: key, non-creatable, non-modifiable
Name of the object store configuration attached to the aggregate. Attributes: key, non-creatable, non-modifiable
UUID of the volume. Attributes: non-creatable, non-modifiableplex-attributes
Information about a plex.
"true" if the plex is online, "false" otherwise.
"true" if the plex is currently resyncing, "false" otherwise.
Name of the plex.
If the plex is currently being resynced, then the completion percentage floored to two decimal places. (e.g. "13.12")
Plex status. Possible values: "normal", "failed", "empty", "invalid", "uninitialized", "failed assimilation", "limbo", "active", "inactive", "resyncing", These values may appear by themselves or in combination separated by commas (e.g., "normal,active")
The pool to which the majority of disks in the plex belong.
List of all RAID groups in the plex.
If the plex is currently being resynced, then the resync level.
If the plex is currently being resynced, then the completion percentage.raid-type
Raid type of the aggregate.
raidgroup-attributes
Information about a raidgroup.
Checksum style for the RAID group. The possible values are:
"true" if the RAID group is composed of SSDs and the owning aggregate is hybrid (group is not part of usable space).
"True" if the RAID group is currently recomputing parity.
"true" if the RAID group is currently reconstructing.
Name of the RAID group.
The percentage of parity recomputation completed, if is-recomputing-parity is true. Range : [0-100]
If reconstruction is going on, then the completion percentage.space-information
Space configuration info When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Name of the aggregate for which the space usage is requested. Attributes: non-creatable, non-modifiable
This field represents space used by filesystem metadata of the aggregate. Attributes: non-creatable, non-modifiable
Aggregate Metadata Percent Attributes: non-creatable, non-modifiable
This field represents the size of the aggregate in bytes. Attributes: non-creatable, non-modifiable
This field represents the space used by metadata in the object store (in bytes). Attributes: non-creatable, non-modifiable
Metadata Percent. Attributes: non-creatable, non-modifiable
This field represents the total amount of space used in the object store. Attributes: non-creatable, non-modifiable
Used Percentage. Attributes: non-creatable, non-modifiable
This field represents the space still referenced in the object store (in bytes). Attributes: non-creatable, non-modifiable
Referenced Capacity Percentage. Attributes: non-creatable, non-modifiable
This field represents the space saved by storage efficiency in the object store. Attributes: non-creatable, non-modifiable
Storage efficiency saved percentage. Attributes: non-creatable, non-modifiable
This field represents the size of the object store. Attributes: non-creatable, non-modifiable
This field represents the amount of space that is no longer referenced in the object store. This space has yet to be reclaimed. Attributes: non-creatable, non-modifiable
Unreclaimed Space Percentage. Attributes: non-creatable, non-modifiable
Space Reserved for Snapshot Copies Attributes: non-creatable, non-modifiable
This field represents physical used space in bytes. This differs from 'total-used' space by the space that is guaranteed for future writes. The value includes blocks in use by Snapshot copies. Attributes: non-creatable, non-modifiable
Physical Used Percentage Attributes: non-creatable, non-modifiable
This field represents snapshot size in bytes. Attributes: non-creatable, non-modifiable
This field represents snapshot reserve that is not available in bytes. Attributes: non-creatable, non-modifiable
Snapshot Reserve Unusable Percent Attributes: non-creatable, non-modifiable
This field represents the name of the performance or capacity tier. Attributes: non-creatable, non-modifiable
This field represents space used by the aggregate including the aggregate's Snapshot reserve in bytes. Attributes: non-creatable, non-modifiable
Total Used Percent Attributes: non-creatable, non-modifiable
This field represents space used by the sum of all data and metadata of all volumes in the aggregate. Attributes: non-creatable, non-modifiable
Volume Footprints Percent Attributes: non-creatable, non-modifiablestorage-pool-name
Name of the storage pool
striping-type
Striping information of aggregate. Allowed values are:
time-interval
Time interval in seconds Range : [0..2^32-1].
verify-detail-info
Information about mirror verification.
Is mirror verification suspended for this aggregate?
Name of the aggregate.
Mirror verification percentage complete floored to two decimal place. If verification isn't active, this value won't be returned. (e.g. "13.12")
Mirror verification percentage complete. If verification isn't active, this value won't be returned. Range: [0..100].warning-code
Warning codes for pre-check mode.
Warning code.antivirus-policy
Antivirus policy name
av-engine-option
Antivirus engine options When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Max Cache Size for Scanning Files (MB) Attributes: non-creatable, modifiable
File count to decompress in archive Attributes: non-creatable, modifiable
Max size of files in archive Attributes: non-creatable, modifiable
Max layers to traverse in archive Attributes: non-creatable, modifiable
Max decompression size factor of files in archive Attributes: non-creatable, modifiable
Scan archive file formats Attributes: non-creatable, modifiable
Heuristic Virus Search Analysis Attributes: non-creatable, modifiable
Spyware enable/disable Attributes: non-creatable, modifiable
Macro Virus Search Analysis Attributes: non-creatable, modifiable
Mark the State of Files Greater Than 2GB Clean Attributes: non-creatable, modifiable
Max recursion depth into archives Attributes: non-creatable, modifiable
Max Lines to Scan to Identify MIME file Attributes: non-creatable, modifiable
proxy server name e.g. http://proxy_server_name Attributes: non-creatable, modifiable
proxy server login Attributes: non-creatable, modifiable
proxy server password Attributes: non-creatable, modifiable
proxy server port number Attributes: non-creatable, modifiable
Scan MIME-Encoded Files Attributes: non-creatable, modifiableav-event-info
Log Entry Written by an Antivirus Agent When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
When the event is logged. The time value is in seconds since January 1, 1970. Attributes: key, required-for-create, non-modifiable
Vendor ID Attributes: optional-for-create, modifiable
Vendor String Attributes: key, required-for-create, non-modifiableprotocol
Available protocols to be scanned Possible values:
aggregatetype
hdd | hybrid | lun | ssd | vmdisk Possible values:
cifs-share-name
The name of the CIFS share. The CIFS share name is a Unicode string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?
export-policy-name
The name of the export policy
job-state
Jobs execute as self-contained state machines. They follow a series of careful steps from creation to destruction. These steps are dictated by the states that they find themselves in as well as the allowable list of states they may transition into. The state can be an indicator of whether a job is executing and if not, why that is the case. Possible values:
junction-path
The Junction Path.
lun-path
LUN Path
snapshot-id
Snapshot Id
audit-info
Audit logging can be enabled/disabled separately for 'get' (read-only) requests, for each of the following access modes: CLI (Command-Line Interface), SNMP, HTTP, and the Data ONTAP API (ONTAPI, ZAPI). The state of these flags is represented via the audit-info typedef. When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Enable Auditing of CLI Get Operations Attributes: non-creatable, modifiable
Enable auditing of CLI set operations Attributes: non-creatable, modifiable
Enable Auditing of HTTP Get Operations Attributes: non-creatable, modifiable
Enable auditing of HTTP set operations Attributes: non-creatable, modifiable
Enable Auditing of Data ONTAP API Get Operations Attributes: non-creatable, modifiable
Enable auditing of Data ONTAP API set operations Attributes: non-creatable, modifiable
Enable Auditing of SNMP Get Operations Attributes: non-creatable, modifiable
Enable auditing of SNMP set operations Attributes: non-creatable, modifiableaudit-log-info
View the audit log When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The actual log message from the audit log file. Attributes: non-creatable, non-modifiable
Node that logged the entry. Attributes: key, non-creatable, non-modifiable
Used as a tie-breaker for line entries with the same timestamp. Attributes: key, non-creatable, non-modifiable
Timestamp of the log entry. Attributes: key, non-creatable, non-modifiableaod-download
aod_download Possible values:
aod-download-status
aod_download_status Possible values:
asup-check-status
ok|warning|failed|not-run Possible values:
asup-content-type
Type of AutoSupport content Possible values:
asup-destination
smtp|http|noteto|retransmit Possible values:
asup-invoke-style
test|performance|all Possible values:
asup-manifest-status
AutoSupport manifest collection status Possible values:
asup-status
AutoSupport general status Possible values:
asup-subsystems
subsys1,subsys2,... Possible values:
asup-transport
smtp|http|https Possible values:
autosupport-budget-info
AutoSupport budget data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The default setting for diagnostic content collection size (in bytes) for the subsystem. Attributes: non-creatable, non-modifiable
The default setting for diagnostic content collection time (in seconds) for the subsystem. Attributes: non-creatable, non-modifiable
The default setting for basic and troubleshooting content collection size (in bytes) for the subsystem. Attributes: non-creatable, non-modifiable
The default setting for basic and troubleshooting content collection time (in seconds ) for the subsystem. Attributes: non-creatable, non-modifiable
The maximum allowable diagnostic content collection size (in bytes) for the subsystem. Attributes: non-creatable, modifiable
The maximum allowable diagnostic content collection time (in seconds) for the subsystem. Attributes: non-creatable, modifiable
The name of a filer on which the AutoSupport tool is running. Attributes: key, non-creatable, non-modifiable
The maximum allowable basic and troubleshooting content collection size (in bytes) for the subsystem. Attributes: non-creatable, modifiable
The name of a subsystem from which AutoSupport collects data. Attributes: key, non-creatable, non-modifiable Possible values:
The maximum allowable basic and troubleshooting content collection time (in seconds ) for the subsystem. Attributes: non-creatable, modifiableautosupport-check-info
Status of AutoSupport Subsystem When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Category of AutoSupport Check Attributes: key, non-creatable, non-modifiable Possible values:
Type of AutoSupport Check Attributes: key, non-creatable, non-modifiable Possible values:
Action to correct the error seen as the result of this check. Attributes: non-creatable, non-modifiable
Detailed Error String for this AutoSupport Check. Attributes: non-creatable, non-modifiable
The name of the filer on which the check is being performed. Attributes: key, non-creatable, non-modifiable
Status of this AutoSupport Check. Attributes: non-creatable, non-modifiable Possible values:
autosupport-cmd-tgt
Execution domain of AutoSupport content Possible values:
autosupport-compliant-info
Compliant AutoSupport has data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
hash Attributes: non-creatable, non-modifiable
Last AutoSupport that used this hash Attributes: non-creatable, non-modifiable
Node Attributes: key, non-creatable, non-modifiable
Plaintext Attributes: key, non-creatable, non-modifiableautosupport-config-info
AutoSupport configuration data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The e-mail address of the local administrator, used as the sender of the AutoSupport message. Attributes: non-creatable, modifiable
Specifies whether the AutoSupport daemon is enabled. When this setting is disabled, delivery of all AutoSupport messages is turned off. Attributes: non-creatable, modifiable
Used to enable / disable collection of AutoSupport data when the AutoSupport daemon is disabled. When this setting is true, collection of AutoSupport data will still be done if is-enabled is false. Attributes: non-creatable, modifiable
Used to enable / disable collection of disk health data. Attributes: non-creatable, modifiable
Specifies whether the filer's hostname should be part of an AutoSupport message's subject field. Attributes: non-creatable, modifiable
Specifies whether the AutoSupport OnDemand Download feature is enabled. Default is true. Attributes: non-creatable, modifiable
Specifies whether AutoSupport OnDemand is enabled. Default is true. Attributes: non-creatable, modifiable
Specifies whether the AutoSupport OnDemand Remote Diagnostics feature is enabled. Default is true. Attributes: non-creatable, modifiable
Used to enable / disable collection of Performance AutoSupport data. Attributes: non-creatable, modifiable
Used to enable / disable removal of customer-supplied data. Attributes: non-creatable, modifiable
Specifies whether to enable / disable AutoSupport reminders. Attributes: non-creatable, modifiable
Specifies whether AutoSupport notification to technical support is enabled. Attributes: non-creatable, modifiable
Specifies whether to enable / disable throttling to prevent a potential avalanche of AutoSupport messages. Attributes: non-creatable, modifiable
The subject field of the last generated AutoSupport message. Attributes: non-creatable, non-modifiable
The timestamp of the last generated AutoSupport message. The time value is in seconds since January 1, 1970 UTC. Attributes: non-creatable, non-modifiable
The EMS trigger of the last generated AutoSupport message. Attributes: non-creatable, non-modifiable
The name of the mail server(s) used to deliver AutoSupport messages via SMTP. Both host names and IP addresses may be used as valid input. One can optionally specify a username/password for authentication with the mailserver(rfc4954). Attributes: non-creatable, modifiable
Maximum download rate (in bytes per second). As of Data ONTAP 8.3.1, this value should be either 0 (for unlimited) or in the range 20480 (20KBps)- 10737418240 (10GBps). Attributes: non-creatable, modifiable
Delivery size limit for the HTTP transport protocol (in bytes). As of Data ONTAP 8.3.1, this value should be either 0 (for unlimited) or greater than or equal to 2097152 (2MB). Attributes: non-creatable, modifiable
Delivery size limit for the SMTP transport protocol (in bytes). As of Data ONTAP 8.3.1, this value should be either 0 (for unlimited) or greater than or equal to 2097152 (2MB). Attributes: non-creatable, modifiable
Maximum upload rate (in bytes per second). As of Data ONTAP 8.3.1, this value should be either 0 (for unlimited) or greater than or equal to 20480 (20KBps). Attributes: non-creatable, modifiable
Minimum Length for Sensitive Data Attributes: non-creatable, modifiable
The name of the filer that owns the AutoSupport configuration. Attributes: key, non-creatable, non-modifiable
Specifies up to five recipients of short AutoSupport e-mail messages. Attributes: non-creatable, modifiable
The AutoSupport OnDemand Client polling rate in minutes. As of Data ONTAP 8.3.1, this value should be in the range 5-2880. Attributes: non-creatable, modifiable
The AutoSupport OnDemand Server URL. Attributes: non-creatable, modifiable
Specifies up to five partner vendor recipients of full AutoSupport e-mail messages. Attributes: non-creatable, modifiable
The format used to compress the AutoSupport message payload. Attributes: non-creatable, modifiable Possible values:
The transmission window (seconds). Attributes: non-creatable, modifiable
The URL used to deliver AutoSupport messages via HTTP POST. Attributes: non-creatable, modifiable
Optional proxy host for AutoSupport message delivery via HTTP. Attributes: non-creatable, modifiable
The URL used to deliver AutoSupport messages via HTTP PUT. Attributes: non-creatable, modifiable
The maximum number of delivery attempts for an AutoSupport message. As of Data ONTAP 8.3.1, this value should be in the range 5-30. Attributes: non-creatable, modifiable
The number of seconds to wait, after a failed delivery attempt, prior to re-transmitting an AutoSupport message. Attributes: non-creatable, modifiable
The e-mail address of Support. Attributes: non-creatable, modifiable
Specifies up to five recipients of full AutoSupport e-mail messages. Attributes: non-creatable, modifiable
The name of the transport protocol used to deliver AutoSupport messages. Attributes: non-creatable, modifiable Possible values:
Validate Digital Certificate Received Attributes: non-creatable, modifiableautosupport-connectivity-check-info
Test connectivity to AutoSupport destinations When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
OnDemand Server Status Attributes: non-creatable, non-modifiable
Test Current AutoSupport Status Attributes: non-creatable, non-modifiable
Node Attributes: key, non-creatable, non-modifiable
HTTP POST Destination Status Attributes: non-creatable, non-modifiable
HTTP PUT Destination Status Attributes: non-creatable, non-modifiableautosupport-destinations-info
AutoSupport destination summary When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
A comma separated list of destinations used to deliver AutoSupport messages. Attributes: non-creatable, non-modifiable
The name of the filer that owns this destination configuration. Attributes: key, non-creatable, non-modifiableautosupport-download-info
AutoSupport OnDemand download data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The type of the download. Attributes: non-creatable, non-modifiable Possible values:
The error string recorded for this download. This string may be empty. Attributes: non-creatable, non-modifiable
The download ID. Attributes: key, non-creatable, non-modifiable
The timestamp of the last update to this download record. The time value is in seconds since January 1, 1970 UTC. Attributes: non-creatable, non-modifiable
The name of the filer that performed the download. Attributes: key, non-creatable, non-modifiable
The path to the downloaded results on the filer. Attributes: non-creatable, non-modifiable
The status for this download. Attributes: non-creatable, non-modifiable Possible values:
autosupport-history-info
AutoSupport history data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The number of attempted deliveries for this AutoSupport message. Attributes: non-creatable, non-modifiable
The decompressed size in bytes of the Autosupport message. Attributes: non-creatable, non-modifiable
The transport protocol for this AutoSupport message's destination. Attributes: key, non-creatable, non-modifiable Possible values:
The timestamp of the original generation (collection) of this AutoSupport message. The time value is in seconds since January 1, 1970 UTC. Attributes: non-creatable, non-modifiable
The timestamp of the last update to this history record. The time value is in seconds since January 1, 1970 UTC. Attributes: non-creatable, non-modifiable
The name of the filer where the AutoSupport message was previously generated. Attributes: key, non-creatable, non-modifiable
The perentage of the AutoSupport message transmitted successfully. Attributes: non-creatable, non-modifiable
The AutoSupport message sequence number. Attributes: key, non-creatable, non-modifiable
The compressed size in bytes of the AutoSupport message. Attributes: non-creatable, non-modifiable
The delivery status for this AutoSupport message. Attributes: non-creatable, non-modifiable Possible values:
The subject field of this AutoSupport message. Attributes: non-creatable, non-modifiable
The estimate of the amount of time for the AutoSupport Message to be fully transmitted. Attributes: non-creatable, non-modifiable
The total collection time in msec of the Autosupport message. Attributes: non-creatable, non-modifiable
The name of the EMS event that triggered this AutoSupport message. Attributes: non-creatable, non-modifiable
The approximate rate in bytes per second of the AutoSupport Message upload. Attributes: non-creatable, non-modifiable
The URI used to deliver this AutoSupport message. Attributes: non-creatable, non-modifiableautosupport-invoke-diagnostic-iter-info
Information about the operation that was attempted/performed against autosupport object.
The keys for the autosupport object to which the operation applies.
Error code, if the operation caused an error.
Error description, if the operation caused an error.
The AutoSupport message sequence number.autosupport-invoke-iter-info
Information about the operation that was attempted/performed against autosupport object.
The keys for the autosupport object to which the operation applies.
Error code, if the operation caused an error.
Error description, if the operation caused an error.
The AutoSupport message sequence number.autosupport-invoke-performance-archive-iter-info
Information about the operation that was attempted/performed against autosupport object.
The keys for the autosupport object to which the operation applies.
Error code, if the operation caused an error.
Error description, if the operation caused an error.
The AutoSupport message sequence number.autosupport-manifest-info
AutoSupport manifest data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
The AutoSupport Content Filename for this Data Attributes: non-creatable, non-modifiable
Actual Data Being Collected Attributes: non-creatable, non-modifiable
Execution Domain for Command Attributes: non-creatable, non-modifiable Possible values:
AutoSupport Content Type for this Data Attributes: non-creatable, non-modifiable Possible values:
Textual Description of Error Attributes: non-creatable, non-modifiable
Node Attributes: key, non-creatable, non-modifiable
Initial Number of Bytes Collected Attributes: non-creatable, non-modifiable
Priority Order of Collection Attributes: key, non-creatable, non-modifiable
Table Query for XML Collection Attributes: non-creatable, non-modifiable
AutoSupport Sequence Number Attributes: key, non-creatable, non-modifiable
Number of Bytes Collected Attributes: non-creatable, non-modifiable
Compressed Size Attributes: non-creatable, non-modifiable
Status of this Data Item Attributes: non-creatable, non-modifiable Possible values:
Subsystem Attributes: non-creatable, non-modifiable Possible values:
Collection Time for this Data Item (ms) Attributes: non-creatable, non-modifiableautosupport-trigger-info
AutoSupport trigger data When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
Additional Content Flag Attributes: non-creatable, non-modifiable Possible values:
Additional Subsystems Reporting Basic Info Attributes: non-creatable, modifiable Possible values:
Default Subsystems Reporting Basic Info Attributes: non-creatable, non-modifiable Possible values:
Node Attributes: key, non-creatable, non-modifiable
(DEPRECATED) Deliver to AutoSupport -noteto Addresses. Possible values are: enabled or disabled. Attributes: non-creatable, modifiable
The data collection size budget for this trigger. Content not collected will be marked as collection-truncated-size-limit in the manifest. Attributes: non-creatable, modifiable
The data collection time budget for this trigger (in seconds). Content not collected will be marked as collection-truncated-time-limit in the manifest. Attributes: non-creatable, modifiable
Deliver to AutoSupport -to Addresses. Possible values are: enabled or disabled. Attributes: non-creatable, modifiable
EMS Message Attributes: key, non-creatable, non-modifiable
Additional Subsystems Reporting Troubleshooting Info Attributes: non-creatable, modifiable Possible values:
Default Subsystems Reporting Troubleshooting Info Attributes: non-creatable, non-modifiable Possible values:
byte-rate
Bytes per second Range : [0..2^63-1].
compression-format
7z|tgz Possible values:
mail-address
E-mail Address
capability-info
Storage Capability Info Typedef When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
No administrative action required to disable capability. Attributes: optional-for-create, modifiable
No administrative action required to enable capability. Attributes: optional-for-create, modifiable
The capability name. Attributes: key, required-for-create, non-modifiable
A description of the capability. Attributes: optional-for-create, modifiable
Ready to be enabled. Attributes: optional-for-create, modifiable
A reflection of whether some feature is using the capability or not. Attributes: required-for-create, modifiable
How to downgrade instructions. Attributes: optional-for-create, modifiable
Marked for Downgrade Attributes: optional-for-create, modifiable
The name of the node in which the capability is installed. Attributes: key, required-for-create, non-modifiable
Object name, for e.g., 'volume', 'storage.aggregate', 'vserver.nfs' etc.. Attributes: key, non-creatable, non-modifiable
A boolean indication as to whether the capability has become obsolete or not. Attributes: optional-for-create, modifiable
Operation details. Contains the operation name, command path and API name.
The release in which the capability was introduced. Attributes: optional-for-create, modifiable
The capability must be present in the booting image if the capability was previously enabled. Attributes: optional-for-create, modifiable
The capability must be present on all nodes before use. Attributes: optional-for-create, modifiable
Uses enable-ready. Attributes: optional-for-create, modifiableadvanced-options
Advanced Options
Specifies the amount of time, in seconds, the source node has to wait for the destination node to complete the aggregate migration before declaring the migration as failed. Default: 120 seconds. Attributes: non-creatable, modifiable
Specifies failover outage durations to allow CIFS NDO lite customers to tune the NVlog size. A value of 'default' uses the maximum NVRAM possible. Attributes: non-creatable, modifiable Possible values:
Specifies whether storage-failover status is communicated via mailbox disks. Default: true Attributes: non-creatable, modifiable
Specifies how frequently, in seconds, the node reads its partner's status from the mailbox disks. Default: 5 seconds Attributes: non-creatable, modifiable
Specifies how frequently, in seconds, the node writes its status to the mailbox disks. Default: 5 seconds Attributes: non-creatable, modifiableadvanced-options-modify
Advanced Options to Modify
Specifies the amount of time, in seconds, the source node has to wait for the destination node to complete the aggregate migration before declaring the migration as failed. Default: 120 seconds. Attributes: non-creatable, modifiable
Specifies failover outage durations to allow CIFS NDO lite customers to tune the NVlog size. A value of 'default' uses the maximum NVRAM possible. Attributes: non-creatable, modifiable Possible values:
Specifies whether storage-failover status is communicated via mailbox disks. Default: true Attributes: non-creatable, modifiable
Specifies how frequently, in seconds, the node reads its partner's status from the mailbox disks. Default: 5 seconds Attributes: non-creatable, modifiable
Specifies how frequently, in seconds, the node writes its status to the mailbox disks. Default: 5 seconds Attributes: non-creatable, modifiablecf-aggregate-giveback-info
Giveback status of an aggregate When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
Failure reason, incase giveback of this aggregate failed. Possible values include:
Attributes: non-creatable, non-modifiable
If giveback is in progress, then this is set to the module which is currently running. If giveback was failed or vetoed by a certain module then this is set to the first module which failed the giveback. Example: WAFL. Attributes: non-creatable, non-modifiable
Giveback status of the aggregate Possible values include:
Attributes: non-creatable, non-modifiable
Aggregate name Attributes: non-creatable, non-modifiable
Node to which the aggregate is being given back Attributes: non-creatable, non-modifiable
Node performing the giveback of aggregate Attributes: key, non-creatable, non-modifiablecf-modify-iter-info
Information about the modify operation that was attempted/performed against cf object.
The keys for the cf object to which the modify operation applies.
Error code, if the modify operation caused an error.
Error description, if the modify operation caused an error.cifsndoduration
CIFS NDO outage duration Possible values:
disk-uid
Disk Unique Identifier
giveback-options
Giveback Options
Specifies whether a node should attempt automatic giveback operations if takeover was because of a disruption in the partner's operation Attributes: non-creatable, modifiable
True, if auto-giveback is enabled, false otherwise. Default: false, except for two-node clusters where the default is true. Attributes: non-creatable, modifiable
Specifies whether long-running operations (for instance, NDMP dump/restoration, volume verification, etc.) are terminated and partner veto votes are overriden when an automatic giveback operation is initiated. Attributes: non-creatable, modifiable
Specifies the minimum time, in seconds, that a node will stay in takeover state prior to performing an automatic giveback. Default: 600 seconds Attributes: non-creatable, modifiable
Specifies whether the node checks that its partner is waiting-for-giveback before initiating a giveback. If check-partner is false, aggregates will be given back even if the partner is not up and ready potentially leading to longer outage. Default: true Attributes: non-creatable, modifiable
Specifies the number of times the node attempts an automatic giveback within the time period specified by giveback-attempts-interval. Default: 2 Attributes: non-creatable, modifiable
Specifies the time period, in minutes, used by the giveback-attempts-count parameter Default: 60 minutes Attributes: non-creatable, modifiablegiveback-options-modify
Giveback Options to Modify
Specifies whether a node should attempt automatic giveback operations if takeover was because of a disruption in the partner's operation Attributes: non-creatable, modifiable
True, if auto-giveback is enabled, false otherwise. Default: false, except for two-node clusters where the default is true. Attributes: non-creatable, modifiable
Specifies whether long-running operations (for instance, NDMP dump/restoration, volume verification, etc.) are terminated and partner veto votes are overriden when an automatic giveback operation is initiated. Attributes: non-creatable, modifiable
Specifies the minimum time, in seconds, that a node will stay in takeover state prior to performing an automatic giveback. Default: 600 seconds Attributes: non-creatable, modifiable
Specifies whether the node checks that its partner is waiting-for-giveback before initiating a giveback. If check-partner is false, aggregates will be given back even if the partner is not up and ready potentially leading to longer outage. Default: true Attributes: non-creatable, modifiable
Specifies the number of times the node attempts an automatic giveback within the time period specified by giveback-attempts-interval. Default: 2 Attributes: non-creatable, modifiable
Specifies the time period, in minutes, used by the giveback-attempts-count parameter Default: 60 minutes Attributes: non-creatable, modifiablegiveback-related-info
Giveback related Info
This is the reason for the giveback failure. Possible values are:
Attributes: non-creatable, non-modifiable
The current module giveback process is in. e.g. WAFL Attributes: non-creatable, non-modifiable
Giveback state of the node. Possible values are:
Attributes: non-creatable, non-modifiablehamode
High availability mode Possible values:
hatype
none|shared_storage|non_shared_storage Possible values:
interconnect-related-info
Interconnect Info
States of the individual interconnect links. Attributes: non-creatable, non-modifiable
Type and Vendor of the interconnect. Attributes: non-creatable, non-modifiable
True, if storage failover interconnect is up. Attributes: non-creatable, non-modifiablemailbox-io-times-info
Mailbox IO times
Maximum IO time in milliseconds, normal
Maximum IO time in milliseconds, transitionmailbox-state
State of mailbox disks owned by the node. Possible values are:
mailbox-status-info
Mailbox status info.
representation of mailbox status bit. Possible values: mbx_status_nodisks mbx_status_uncertain mbx_status_stale mbx_status_conflicted mbx_status_old_version mbx_status_not_found mbx_status_wrong_state mbx_status_backupnode-related-info
Node Info
Current HA Mode Attributes: non-creatable, modifiable Possible values:
Specifies the type of high-availability configuration. Possible values are:
Attributes: non-creatable, non-modifiable Possible values:
A counter to indicate that the local node is progressing in the current firmware state. If the counter is not progressing the node may be unresponsive or down. Attributes: non-creatable, non-modifiable
Local firmware state that will be communicated through interconnect to the partner. Possible values are:
Attributes: non-creatable, non-modifiable
Node name Attributes: key, non-creatable, non-modifiable
Storage failover status of the node. Possible values are:
Fields
Fields
Fields
Fields
Fields
Virtual disks take the form 'prefix'.'number' where prefix is the storage array's prefix and number is a unique ascending number.
Omitted if Shelf Enclosure Service is not enabled for this device, information is unavailable, or excluded by 'desired-attributes'.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, assuming that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
The following are the possible values for the operational authentication state and their meanings.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values are:
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Possible values:
Default:* Attributes: non-creatable, non-modifiable
Possible values:
Default: * Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Attributes: non-creatable, non-modifiable
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Attributes: key, non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
Attributes: key, non-creatable, non-modifiable
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
It can be 'connected', 'disconnected' or 'connecting'. Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
group mapping configuration for Vservers. The possible sources of group mapping information and the order in which they are searched is determined by the Vserver's 'name-mapping-switch' option. If the 'name-mapping-switch' is set to 'file', the rules in this table are used to determine the mapping. Windows user groups, UNIX user groups and Kerberos principal groups can be three disjoint sets of groups. A mechanism is needed to map groups from one set to another when presenting ACLs across multiprotocol clients. Each group mapping entry represents one such map in a given direction. group mappings are done using standard UNIX style regular expressions for pattern replacement. For example if a configuration is required to convert any Windows user in the Windows domain name 'EXAMPLE' into a UNIX user with the same name in NIS, the direction entry should be set to 'win-unix', the pattern string should be set to '418 :+)' and the replacement string should be set to '\1'. The double backslash (\\) in the pattern matches a single backslash in the source name. The parentheses denote a subexpression but do not match any characters themselves. The 'period' matches any single character. The 'plus' matches one or more characters of the previous expression. The pattern 'EXAMPLE\\(.+)' matches 'EXAMPLE\' followed by one or more of any character. In the replacement, '\1' refers to the string that the first subexpression matched. Assuming the Windows user 'EXAMPLE\user1', the replacement evaluates to 'user1'. If a mapping is required from Windows to UNIX and none of the name mapping entries match, the domain name is stripped from the the username and it is directly mapped to the UNIX user of the same name. Similarly if a mapping is required from a UNIX user to a Windows user and none of the name mapping entries match, the domain name is prefixed to the username and it is directly mapped to a Windows user of the When returned as part of the output, all elements of this typedef are reported, unless otherwise stated in the element???s description or limited by a set of desired attributes specified by the caller.
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
The UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hexadecimal characters, the second through fourth groupings have four hexadecimal characters each, and the fifth and final grouping has 12 hexadecimal characters. Note that a leading '0x' is not used.
This field is available in Data ONTAP 7-mode 7.3.6, 8.0.2, 8.1.0 and later for the igroup-list-info API. This field is available in Data ONTAP Cluster-Mode 8.1.0 and later for the igroup-get-iter and lun-map-list-info APIs.
Here is an example of an actual UUID:
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
An example of a valid IPv4 address range is: '192.168.1.100-192.168.1.150'. An example of a valid IPv6 address range is: '2001:db8::1000:1-2001:db8::1000:50'.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
An example of a valid IPv4 address range is: '192.168.1.100-192.168.1.150'. An example of a valid IPv6 address range is: '2001:db8::1000:1-2001:db8::1000:50'.
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
If 'true', Kerberos security is enabled by creating an account in the Key Distribution Center using the Service Principal Name. If another logical interface uses the same Service Principal Name, the account is shared.
If 'false', Kerberos security is disabled and the associated account is deleted when it is not used by any logical interface. Attributes: non-creatable, modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Examples:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible Values:
Possible Values:
Possible Values:
Possible Values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible Values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
LIF Placement failures:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
An example of a valid IPv4 address range is: '192.168.1.100-192.168.1.150'. An example of a valid IPv6 address range is: '4:3:2:1:d:c:b:b-4:3:2:1:d:c:b:c'
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
A comma indicates ANDing, a pipe indicates ORing, and the order of precedence is AND and then OR. For example, "instance_name=volA,vserver_name=vs1|vserver_name=vs2" equates to "(instance_name=volA && vserver_name=vs1) | (vserver_name=vs2)". This would return instances on Vserver vs1 with the name volA, as well as all of the instances on Vserver vs2.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
If a FlexGroup's constituents have differing quota statuses, the FlexGroup will return a 'mixed' quota status. If one or more of a FlexGroup's constituents are not online or otherwise cannot be reached, the FlexGroup will return an 'unknown' quota status.
If a FlexGroup's constituents have differing quota substatuses, the FlexGroup will return a 'mixed' quota substatus. If one or more of a FlexGroup's constituents are not online or otherwise cannot be reached, the FlexGroup will return an 'unknown' quota substatus.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Attributes: key, non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume. Default: true
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Examples:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. This parameter is not supported for FlexGroup or FlexGroup constituent SnapMirror relationships. Attributes: non-creatable, non-modifiable
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. This parameter is not supported for FlexGroup or FlexGroup constituent SnapMirror relationships. Attributes: non-creatable, non-modifiable
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
If set to true, the snapshot is hard-locked by some application(s) and hence cannot be deleted. The lock cannot be over-ridden and only the application(s) locking the snapshot can release the lock. The output 'snapshot-owners-list' will report the application(s) who have hard-locked the snapshot.
If set to false and some applications are dependent on it, the snapshot is soft-locked and hence cannot be deleted. The output 'dependency' will report the application(s) who have soft-locked the snapshot. In order to over-ride the soft-lock, use the 'ignore-owners' field while deleting the snapshot.
If above conditions don't hold, then snapshot is not locked and can be deleted.
Possible values include:
The default value is valid.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Possible values are:
Possible values are:
Fields
Fields
Possible values are:
Possible values are:
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Possible values:
Virtual disks take the form 'prefix'.'number' where prefix is the storage array's prefix and number is a unique ascending number.
Omitted if Shelf Enclosure Service is not enabled for this device, information is unavailable, or excluded by 'desired-attributes'.
Omitted if both 'is-prefailed' and 'is-replacing' are false, or if excluded by 'desired-attributes'.
Fields
Starting in Data ONTAP 8.1, "zoned/block" is no longer supported.
Possible values:
Possible values:
Virtual disks take the form 'prefix'.'number' where prefix is the storage array's prefix and number is a unique ascending number.
Omitted if Shelf Enclosure Service is not enabled for this device, information is unavailable, or excluded by 'desired-attributes'.
Possible values:
Possible values:
Fields
Fields
Possible values:
Fields
Fields
Possible values:
Possible values:
Possible values:
Possible values:
Fields
Possible values:
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Possible values:
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
The following are the possible language codes along with their names:
To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
If not specified when creating a volume, the Antivirus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
Attributes: optional-for-create, modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
This option when set to 'true', it will generate a new key and create an encrypted volume using that key. Before that, the vserver should be configured with the key-manager.
Attributes: optional-for-create, non-modifiable
Possible values:
Attributes: non-creatable, non-modifiable
Possible values:
Attributes: non-creatable, non-modifiable Possible values:
A new key will be generated for creating an encrypted volume. This key-id is associated with the generated key.
Attributes: non-creatable, non-modifiable
Fields
Attributes: optional-for-create, modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable Possible values:
Attributes: non-creatable, modifiable
Attributes: optional-for-create, modifiable
Fields
Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Default value is 'rw'.
Attributes: optional-for-create, non-modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
The only legal value for a snapshot identifier is its Data Set ID.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
This policy decides whether the blocks of a volume will be tiered to the capacity tier when they become cold. The possible values for this field are:
Attributes: optional-for-create, modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
The default maximum directory size is set to 1% of the system memory. So if the system memory is 1GB, then the maximum directory size value will be 10MB which allows upto 300,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Attributes: optional-for-create, modifiable
Fields
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API.
Attributes: optional-for-create, modifiable
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API.
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
The cache retention priority that is to be associated with the volume. This policy decides how long blocks of a volume will be cached in flash pool once they become cold. The possible values for this field are:
Attributes: optional-for-create, modifiable
The caching policy that is to be associated with the volume. The policy decides how the flash pool caching has to happen for the volume. The possible values for this value are:
Attributes: optional-for-create, modifiable
Possible values:
Attributes: non-creatable, non-modifiable
Fields
This field is returned only if it is explicitly requested using desired-attributes.
This parameter is only supported on FlexGroups.
Attributes: optional-for-create, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
Possible values:
Attributes: optional-for-create, non-modifiable Possible values:
Attributes: optional-for-create, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Possible values:
Attributes: optional-for-create, modifiable
Possible values:
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This value serves as an internal index for a volume. All volumes on a given controller must have unique FSIDs, except for the two special values described below:
A value of 0 indicates that this volume does not currently have a legal FSID for some unexpected reason. Such volumes are forcibly kept offline until this attribute is assigned a legal value.
A value of 1 indicates that this volume has recently appeared on its current controller due to having its aggregate be copied from a different controller. All volumes in this newly-created aggregate must be assigned legal, controller-unique IDs when they are onlined. That will be handled automatically by WAFL upon mount.
If modifiable, this field may be set only when the volume is restricted. It may be set to any value that is not currently being used by any other volume on the same controller. If a request to set this value to '0' is received, the system will select a new value that is currently unused. Note that setting a volume's FSID sometimes has external effects. In particular, a 7-Mode volume's FSID is part of the NFS file handles constructed for its files.
Attributes: non-creatable, non-modifiable
UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Here is an example of an actual UUID:
49e370d6-5b5a-11d9-9eb5-000100000529
Attributes: non-creatable, non-modifiable
The junction parent volume must belong to the same vserver that owns this volume.
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, non-modifiable
This field is valid only for a Cluster-Mode volume.
Attributes: non-creatable, non-modifiable
Attributes: key, required-for-create, non-modifiable
Ordinals are used to disambiguate volumes that have the same base name on the same controller. A value of zero indicates that the base volume name is unique on a controller. A value greater than zero indicates that the volume's base name is used by two or more volumes on the same controller, and that appending '(n)' to this volume's name uniquely identifies it on that controller. A value of -1 indicates that the name ordinal has not yet been determined.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This field is returned only if it is explicitly requested using desired-attributes.
This parameter is only supported on FlexGroups.
Attributes: optional-for-create, non-modifiable
Attributes: key, non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Here is an example of an actual UUID:
49e370d6-5b5a-11d9-9eb5-000100000529
Attributes: non-creatable, non-modifiable
Possible values:
Default value is 'flex'.
Attributes: non-creatable, non-modifiable Possible values:
Possible values:
Attributes: non-creatable, non-modifiable
Possible values:
Default value is 'rw'.
Attributes: optional-for-create, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
Attributes: optional-for-create, non-modifiable Possible values:
Whether to enable Snapdiff. If enabled, the namespace mirrors will be created for Snapdiff use. The default value is false.
Attributes: optional-for-create, modifiable
Specifies if the volume is managed by GUI services. The deafult value is false.
Attributes: optional-for-create, modifiable
The maximum size of each data constituent in bytes. The default value is determined by checking the maximum FlexVol size setting on all nodes used by the Infinite Volume. The smallest value found is chosen as the default for the max-data-constituent-size for the Infinite Volume.
Attributes: optional-for-create, modifiable
The maximum size of the namespace constituent. The default value is 10TB.
Attributes: optional-for-create, modifiable
Specifies an array of names of aggregates to be used for Infinite Volume Namespace Mirror constituents. If this input is not specified all the aggregates assigned to the Vserver are used. If the argument 'enable-snapdiff' is being set to 'true', and the Infinite Volume is managed by storage services, a value must be provided.
Attributes: optional-for-create, modifiable
The name of the initial storage service for the Infinite Volume. This can only be provided if is-managed-by-service is true.
Attributes: optional-for-create, modifiable
Fields
Possible values:
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
Note that this field can be set to false if and only if the volume is a 7-Mode volume, or a Cluster-Mode volume that was transitioned from 7-Mode.
Attributes: non-creatable, modifiable
Note that this field can be set to false if and only if the volume is a 7-Mode volume.
Attributes: non-creatable, non-modifiable
Example: 'en_US (English (US)).'
Attributes: non-creatable, non-modifiable
Volume language can be specified using 'language-code' parameter.
Attributes: optional-for-create, non-modifiable
This field is of the following format:
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.'
It uses the C Programming Language Printf format:
This format takes the following parameters in order:
E.g., If the volume language code is set to 'en_US,' the default NFS character set is as follows:
Attributes: non-creatable, non-modifiable
This field is of the following format:
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.'
It uses the C Programming Language Printf format:
This format takes the following parameters in order:
E.g., If the volume language code is set to 'en_US,' the default OEM character set is as follows:
Attributes: non-creatable, non-modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
For load-sharing relationships a volume becomes a SnapMirror source at the time a SnapMirror relationship with the volume as the source is created. For all other relationship types, a volume does not become a SnapMirror source until just after a snapmirror-initialize of the relationship begins. Also if a snapmirror-release is performed on the relationship, the volume will no longer be considered a SnapMirror source.
Attributes: non-creatable, non-modifiable
This mirror's active filesystem can be inconsistent during snapmirror transfer. As a result, snapshot create operation is temporary disabled on this mirror until the current transfer session finishes.
This field is set to true at the start of a SnapMirror transfer session and set to false at the end of that session.
Attributes: non-creatable, non-modifiable
If modifiable, when setting this attribute, invalid snapshot id or a non-existent snapshot id specified will be rejected with error ESNAPSHOTDOESNOTEXIST. Failure to set ('stamp') the attribute in the volume will cause error ESTAMPREDIRECTSNAPIDERROR to be returned. This field can be set only for online volumes. This option is valid only in Cluster-Mode. The volume can be set to have no redirection snapshot by using a value of 0. This option can be set only for Cluster-Mode volumes participating in a logical-mirror relationship. Setting this field on a Cluster-Mode volume which is not a logical mirror destination (yet) will not have any impact on client access or the volume's behavior. The client access will be impacted with regard to this value only when the volume is converted to a logical-mirror destination.
When reading this attribute, the value of 0 indicates volume has no redirection snapshot. The field cannot be interpreted authoritatively if the volume is offline or restricted.
Attributes: non-creatable, non-modifiable
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
The following values are recognized:
By default, it is set to 'off'.
Using extents may help workloads that perform many small random writes followed by a large sequential read. However, using extents may increase the number of disk operations performed on the controller, so this field should only be turned on when applicable.
Attributes: non-creatable, modifiable
On by default, only settable in Diag mode.
Attributes: non-creatable, modifiable
This value is useful for volumes with extremely high read traffic, since it prevents writes to the inode file for the volume from contending with reads from other files.
By default, this value is true.
This field should be used carefully. That is, use this field when you know in advance that the correct access time for inodes will not be needed for files on that volume.
Attributes: non-creatable, modifiable
This option is deprecated.
Attributes: optional-for-create, modifiable
By default, this field is false, causing the node that contains this volume to perform very aggressive read-ahead.
Attributes: non-creatable, modifiable
The following values are recognized:
By default, it is set to 'off'.
Using read reallocation may help workloads that perform a mixture of random writes and large sequential reads.
Attributes: non-creatable, modifiable
Possible values:
The default value is 'off'. Attributes: non-creatable, non-modifiable
Fields
This optionally specifies which QoS adaptive policy group to apply to the volume. This policy group defines measurable service level objectives (SLOs) that adjust based on the volume allocated space or used space. This parameter is not supported on Infinite Volumes.
Attributes: optional-for-create, modifiable
This optionally specifies which QoS policy group to apply to the volume. This policy group defines measurable service level objectives (SLOs) that do not adjust based on the volume allocated space or used space. If you do not assign a policy group to a volume, the system will not monitor and control the traffic to it. This parameter is not supported on Infinite Volumes.
Attributes: optional-for-create, modifiable
Fields
Possible values:
This field is only returned if this volume is online. If this field is empty ('') or not present for an online volume, this attribute isn't applicable to the volume. Only Infinite Volumes can use the 'unified' security style. All other volumes cannot use the 'unified' security style. Using 'unified' for a non-Infinite Volume will result in an error. FlexGroups and FlexGroup Constituents can only have 'unix' security style. Setting other security styles for FlexGroups or FlexGroup Constituents will result in an error.
Attributes: optional-for-create, modifiable
Fields
Attributes: optional-for-create, modifiable
It's similar to Unix style permission bits:
In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users.
In Data ONTAP Cluster-Mode, for security style 'mixed' or 'unix', the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style 'ntfs', the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
Attributes: non-creatable, non-modifiable Possible values:
Fields
The default value is true.
Attributes: non-creatable, non-modifiable
The default value is true.
Attributes: non-creatable, modifiable
If true, all initial and intermediate backing snapshots are unlocked for all inactive LUN clones. For active LUN clones, only the backing snapshot will be locked.
If false, the backing snapshot will remain locked until all intermediate backing snapshots are deleted.
This field is deprecated and will always be false in Data ONTAP 8.3 and later.
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
The default policy name is 'default'.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
Attributes: optional-for-create, modifiable
Fields
This option determines the snapshots that 'snapshot autodelete' is allowed to delete to get back space. Setting this option to 'try' only permits the snapshots which are not locked by data protection utilities (dump, mirroring, NDMPcopy) and data-backing functionalities (volume and LUN clones) to be deleted. Setting this option to 'disrupt' permits all snapshots including the snapshots which are locked by data-backing functionalities (volume and LUN clones) to be deleted. This field is not set on FlexGroups.
Attributes: non-creatable, modifiable
This option determines which kind of snapshots to delete. Setting this option value to 'scheduled' will delete the snapshots created by the snapshot scheduler last. Setting this option value to 'user_created' will delete the snapshots not created by the snapshot scheduler last. Setting this option value to 'prefix' will delete the snapshots matching the prefix string to be deleted last. Setting this option value to 'none' will disable the above choices. This field is not set on FlexGroups.
Attributes: non-creatable, modifiable
This option determines if the oldest or newest snapshot is deleted first. This field is not set on FlexGroups.
Attributes: non-creatable, modifiable
This options specifies the list of service that can be destroyed if the snapshot is backing that service. This option is valid only when the commitment is set to 'destroy'. The option 'lun_clone,file_clone' should be used for deleting snapshot backing LUN clone and/or File clone. The option 'lun_clone,sfsr' should be used for deleting snapshot backing LUN clone and/or SFSR. It must be noted that 'lun_clone', 'file_clone' and 'sfsr' individually are not valid values. Only pairs of 'lun_clone,file_clone' and 'lun_clone,sfsr' are supported. This field is not set on FlexGroups.
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
This option determines the condition in which snapshots should be automatically deleted. This field is not set on FlexGroups.
If modifiable, setting this option to 'volume' triggers snapshot autodelete to run when the volume is near full. Setting this option to 'snap_reserve' triggers snapshot autodelete to run when the snap reserve of the volume is near full. Setting this option to 'space_reserve' triggers snapshot autodelete to run when the space reserved in the volume is near full.
Attributes: non-creatable, modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This option is automatically set to 'true' when a volume becomes SnapMirrored. It remains true after the SnapMirror relationship is broken for the volume. This field allows a volume to be SnapMirrored back to the source without needing to grow the source volume. If the volume size is larger than the file system size, setting this field to false forces the file system to grow to the size of the volume.
Attributes: non-creatable, modifiable
Attributes: optional-for-create, modifiable
By default, space guarantee is enabled.
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
By default, space SLO type is none and is enabled.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This parameter is only supported on FlexGroups.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
By default, it is set to 100, indicating that 100% of the required reserved space will actually be reserved so the objects are fully protected for overwrites.
Using a value of less than 100 indicates the percentage of the required reserved space should actually be reserved. This returns the extra space to the available space for the volume, decreasing the total amount of space used. However, this does leave the protected objects in the volume vulnerable to out of space errors, since less than 100% of the required reserved space is actually reserved. If reserved space becomes exhausted, this will cause disruptions on the hosts using the objects. If the percentage is decreased below 100%, it is highly recommended that the administrator actively monitor the space usage on the volume and take corrective action if the reserved space nears exhaustion.
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
This parameter is only supported if the volume is in an aggregate that is either attached to object store or could be attached to an object store.
Attributes: non-creatable, non-modifiable
This parameter is only supported if the volume is in an aggregate that is either attached to object store or could be attached to an object store.
Attributes: non-creatable, non-modifiable
This field is valid only if the volume is online.
Attributes: non-creatable, non-modifiable
This field is valid only if the volume is online.
Attributes: non-creatable, non-modifiable
This field can not be set on Infinite Volumes that are managed by storage services.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This field is valid only if the volume is online.
Attributes: non-creatable, modifiable
Possible options:
This field is valid only if the volume is online. For data-cache volumes, this field is not returned.
This field can not be set on Infinite Volumes that are managed by storage services.
Attributes: optional-for-create, modifiable Possible values:
There are two available settings:
Attributes: non-creatable, modifiable
This field is valid only if the volume is online.
Attributes: non-creatable, modifiable
none: The value of none does not provide any guarantee for overwrites or enforce any restrictions. It should be used if the admin plans to manually manage space consumption in the volume and aggregate, and out of space errors.
thick: The value of thick guarantees that the hole fills and overwrites to space-reserved files in this volume will always succeed by reserving space. To meet this space SLO, the following volume-level settings are automatically set and cannot be modified:
semi-thick: The value of semi-thick is a best-effort attempt to ensure that overwrites succeed by restricting the use of features that share blocks and auto-deleting backups and Snapshot copies in the volume. To meet this space SLO, the following volume-level settings are automatically set and cannot be modified:
Possible options:
This field is valid only if the volume is online. For data-cache volumes, this field is not returned.
This field can not be set on Infinite Volumes that are managed by storage services.
Attributes: optional-for-create, modifiable Possible values:
Fields
By default, this field is false.
Attributes: non-creatable, non-modifiable
The protocol access on the volume in 'in-nvfailed-state' is blocked. This will cause the client applications to crash and thus prevent access to data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
Attributes: non-creatable, modifiable
By default, this field is false.
Attributes: non-creatable, non-modifiable
By default, this field is false.
Attributes: non-creatable, modifiable
Cluster-Mode volumes are not supported in 7-Mode Data ONTAP deployments. All such volumes are forced offline whenever they are detected in that environment.
Similarly, all 7-Mode volumes on a Data ONTAP Cluster-Mode system (except each controller's root volume) are by default forced offline. There are exceptions, in particular when a 7-Mode volume is being prepared to become that controller's new root volume in a recovery scenario.
At the moment, traditional volumes cannot be Cluster-Mode volumes.
By default, this field is false.
Attributes: non-creatable, non-modifiable
The default value is false.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Only the node's internal logic can change this option's value from true to false; this happens when some other volume has the value set to true.
By default, this field is false.
Attributes: non-creatable, non-modifiable
For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data).
It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found.
For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
By default, this field is false.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable.
Attributes: optional-for-create, non-modifiable
Possible values:
Attributes: non-creatable, non-modifiable
Possible values:
If a FlexGroup or Infinite Volume's constituents are not all in the same state, it will return 'mixed'. The 'mixed' state is read-only.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Fields
Possible values:
Attributes: optional-for-create, modifiable
The default setting is equal to the number of striped contituent aggregates.
Attributes: optional-for-create, non-modifiable
Possible values:
Attributes: optional-for-create, modifiable
Possible values:
Attributes: optional-for-create, non-modifiable
The default value is 64 MBytes.
Attributes: optional-for-create, modifiable
Fields
Possible values:
Attributes: non-creatable, non-modifiable
Fields
Fields
Fields
Fields
Attributes: optional-for-create, non-modifiable
Attributes: optional-for-create, non-modifiable
Fields
Possible values:
Attributes: optional-for-create, modifiable Possible values:
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Specifies if this Vserver is a Vserver with Infinite Volume. When part of vserver-get-iter call, this will return the list of matching Vservers. Default value is false.
Prior to Data ONTAP 8.2.0, Vserver with Infinite Volume is called repository Vserver and once a repository Vserver is created in a cluster, additional Vservers cannot be created. Conversely, a repository Vserver cannot be created if non-repository Vservers already exist in a cluster. Attributes: optional-for-create, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Copyright (c) 1994-2013 NetApp, Inc. All rights reserved.
The product described in this manual may be protected by one or more U.S.A. patents, foreign patents, or pending applications.
RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).